FHIR© V4 Dictionary 👉 R5 v4.4.0 2020 Release ✨ c w global consulting, llc (HTHeco©)
last update: 06.30.19
🔍
🔍
🔍

ObjectNameFieldName DescriptionReference
Account resourceType This is a Account resource Account
Account id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Account meta 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. Meta
Account implicitRules 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. uri
Account _implicitRules Extensions for implicitRules Element
Account language The base language in which the resource is written. code
Account _language Extensions for language Element
Account text 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. Narrative
Account contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Account extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Account modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Account identifier Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number). Identifier
Account status Indicates whether the account is presently used/usable or not. enum values:
active
inactive
entered-in-error
on-hold
unknown
Account _status Extensions for status Element
Account type Categorizes the account for reporting and searching purposes. CodeableConcept
Account name Name used for the account when displaying it to humans in reports, etc. string
Account _name Extensions for name Element
Account subject 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. Reference
Account servicePeriod The date range of services associated with this account. Period
Account coverage The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. Account_Coverage
Account owner Indicates the service area, hospital, department, etc. with responsibility for managing the Account. Reference
Account description Provides additional information about what the account tracks and how it is used. string
Account _description Extensions for description Element
Account guarantor The parties responsible for balancing the account if other payment options fall short. Account_Guarantor
Account partOf Reference to a parent Account. Reference
Account_Coverage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Account_Coverage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Account_Coverage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Account_Coverage coverage 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. Reference
Account_Coverage priority The priority of the coverage in the context of this account. positiveInt
Account_Coverage _priority Extensions for priority Element
Account_Guarantor id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Account_Guarantor extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Account_Guarantor modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Account_Guarantor party The entity who is responsible. Reference
Account_Guarantor onHold A guarantor may be placed on credit hold or otherwise have their role temporarily suspended. boolean
Account_Guarantor _onHold Extensions for onHold Element
Account_Guarantor period The timeframe during which the guarantor accepts responsibility for the account. Period
ActivityDefinition resourceType This is a ActivityDefinition resource ActivityDefinition
ActivityDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ActivityDefinition meta 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. Meta
ActivityDefinition implicitRules 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. uri
ActivityDefinition _implicitRules Extensions for implicitRules Element
ActivityDefinition language The base language in which the resource is written. code
ActivityDefinition _language Extensions for language Element
ActivityDefinition text 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. Narrative
ActivityDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ActivityDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ActivityDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ActivityDefinition url 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 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. uri
ActivityDefinition _url Extensions for url Element
ActivityDefinition identifier 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. Identifier
ActivityDefinition version 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. string
ActivityDefinition _version Extensions for version Element
ActivityDefinition name 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. string
ActivityDefinition _name Extensions for name Element
ActivityDefinition title A short, descriptive, user-friendly title for the activity definition. string
ActivityDefinition _title Extensions for title Element
ActivityDefinition subtitle An explanatory or alternate title for the activity definition giving additional information about its content. string
ActivityDefinition _subtitle Extensions for subtitle Element
ActivityDefinition status The status of this activity definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
ActivityDefinition _status Extensions for status Element
ActivityDefinition experimental 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. boolean
ActivityDefinition _experimental Extensions for experimental Element
ActivityDefinition subjectCodeableConcept A code or group definition that describes the intended subject of the activity being defined. CodeableConcept
ActivityDefinition subjectReference A code or group definition that describes the intended subject of the activity being defined. Reference
ActivityDefinition date The date (and optionally time) when the activity definition 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 activity definition changes. dateTime
ActivityDefinition _date Extensions for date Element
ActivityDefinition publisher The name of the organization or individual that published the activity definition. string
ActivityDefinition _publisher Extensions for publisher Element
ActivityDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ActivityDefinition description A free text natural language description of the activity definition from a consumer's perspective. markdown
ActivityDefinition _description Extensions for description Element
ActivityDefinition useContext 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. UsageContext
ActivityDefinition jurisdiction A legal or geographic region in which the activity definition is intended to be used. CodeableConcept
ActivityDefinition purpose Explanation of why this activity definition is needed and why it has been designed as it has. markdown
ActivityDefinition _purpose Extensions for purpose Element
ActivityDefinition usage A detailed description of how the activity definition is used from a clinical perspective. string
ActivityDefinition _usage Extensions for usage Element
ActivityDefinition copyright 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. markdown
ActivityDefinition _copyright Extensions for copyright Element
ActivityDefinition approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
ActivityDefinition _approvalDate Extensions for approvalDate Element
ActivityDefinition lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
ActivityDefinition _lastReviewDate Extensions for lastReviewDate Element
ActivityDefinition effectivePeriod The period during which the activity definition content was or is planned to be in active use. Period
ActivityDefinition topic 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. CodeableConcept
ActivityDefinition author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
ActivityDefinition editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
ActivityDefinition reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
ActivityDefinition endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
ActivityDefinition relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
ActivityDefinition library A reference to a Library resource containing any formal logic used by the activity definition. canonical
ActivityDefinition kind A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource. code
ActivityDefinition _kind Extensions for kind Element
ActivityDefinition profile A profile to which the target of the activity definition is expected to conform. canonical
ActivityDefinition code Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. CodeableConcept
ActivityDefinition intent Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. code
ActivityDefinition _intent Extensions for intent Element
ActivityDefinition priority Indicates how quickly the activity should be addressed with respect to other requests. code
ActivityDefinition _priority Extensions for priority Element
ActivityDefinition doNotPerform 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. boolean
ActivityDefinition _doNotPerform Extensions for doNotPerform Element
ActivityDefinition timingTiming The period, timing or frequency upon which the described activity is to occur. Timing
ActivityDefinition timingDateTime The period, timing or frequency upon which the described activity is to occur. notDefined
ActivityDefinition _timingDateTime Extensions for timingDateTime Element
ActivityDefinition timingAge The period, timing or frequency upon which the described activity is to occur. Age
ActivityDefinition timingPeriod The period, timing or frequency upon which the described activity is to occur. Period
ActivityDefinition timingRange The period, timing or frequency upon which the described activity is to occur. Range
ActivityDefinition timingDuration The period, timing or frequency upon which the described activity is to occur. Duration
ActivityDefinition location Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Reference
ActivityDefinition participant Indicates who should participate in performing the action described. ActivityDefinition_Participant
ActivityDefinition productReference Identifies the food, drug or other product being consumed or supplied in the activity. Reference
ActivityDefinition productCodeableConcept Identifies the food, drug or other product being consumed or supplied in the activity. CodeableConcept
ActivityDefinition quantity Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). Quantity
ActivityDefinition dosage Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. Dosage
ActivityDefinition bodySite Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). CodeableConcept
ActivityDefinition specimenRequirement Defines specimen requirements for the action to be performed, such as required specimens for a lab test. Reference
ActivityDefinition observationRequirement Defines observation requirements for the action to be performed, such as body weight or surface area. Reference
ActivityDefinition observationResultRequirement Defines the observations that are expected to be produced by the action. Reference
ActivityDefinition transform 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. canonical
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. ActivityDefinition_DynamicValue
ActivityDefinition_DynamicValue id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ActivityDefinition_DynamicValue extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ActivityDefinition_DynamicValue modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ActivityDefinition_DynamicValue path 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 resolveable 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). string
ActivityDefinition_DynamicValue _path Extensions for path Element
ActivityDefinition_DynamicValue expression An expression specifying the value of the customized element. Expression
ActivityDefinition_Participant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ActivityDefinition_Participant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ActivityDefinition_Participant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ActivityDefinition_Participant type The type of participant in the action. code
ActivityDefinition_Participant _type Extensions for type Element
ActivityDefinition_Participant role The role the participant should play in performing the described action. CodeableConcept
Address id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Address extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Address use The purpose of this address. enum values:
home
work
temp
old
billing
Address _use Extensions for use Element
Address type Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. enum values:
postal
physical
both
Address _type Extensions for type Element
Address text 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. string
Address _text Extensions for text Element
Address line This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. string
Address _line Extensions for line Element
Address city The name of the city, town, suburb, village or other community or delivery center. string
Address _city Extensions for city Element
Address district The name of the administrative area (county). string
Address _district Extensions for district Element
Address state 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). string
Address _state Extensions for state Element
Address postalCode A postal code designating a region defined by the postal service. string
Address _postalCode Extensions for postalCode Element
Address country Country - a nation as commonly understood or generally accepted. string
Address _country Extensions for country Element
Address period Time period when address was/is in use. Period
AdverseEvent resourceType This is a AdverseEvent resource AdverseEvent
AdverseEvent id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
AdverseEvent meta 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. Meta
AdverseEvent implicitRules 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. uri
AdverseEvent _implicitRules Extensions for implicitRules Element
AdverseEvent language The base language in which the resource is written. code
AdverseEvent _language Extensions for language Element
AdverseEvent text 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. Narrative
AdverseEvent contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
AdverseEvent extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AdverseEvent modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AdverseEvent identifier 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. Identifier
AdverseEvent actuality Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely. enum values:
actual
potential
AdverseEvent _actuality Extensions for actuality Element
AdverseEvent category The overall type of event, intended for search and filtering purposes. CodeableConcept
AdverseEvent event This element defines the specific type of event that occurred or that was prevented from occurring. CodeableConcept
AdverseEvent subject This subject or group impacted by the event. Reference
AdverseEvent encounter The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated. Reference
AdverseEvent date The date (and perhaps time) when the adverse event occurred. dateTime
AdverseEvent _date Extensions for date Element
AdverseEvent detected Estimated or actual date the AdverseEvent began, in the opinion of the reporter. dateTime
AdverseEvent _detected Extensions for detected Element
AdverseEvent recordedDate The date on which the existence of the AdverseEvent was first recorded. dateTime
AdverseEvent _recordedDate Extensions for recordedDate Element
AdverseEvent resultingCondition Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). Reference
AdverseEvent location The information about where the adverse event occurred. Reference
AdverseEvent seriousness Assessment whether this event was of real importance. CodeableConcept
AdverseEvent severity Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is. CodeableConcept
AdverseEvent outcome Describes the type of outcome from the adverse event. CodeableConcept
AdverseEvent recorder Information on who recorded the adverse event. May be the patient or a practitioner. Reference
AdverseEvent contributor Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness). Reference
AdverseEvent suspectEntity Describes the entity that is suspected to have caused the adverse event. AdverseEvent_SuspectEntity
AdverseEvent subjectMedicalHistory AdverseEvent.subjectMedicalHistory. Reference
AdverseEvent referenceDocument AdverseEvent.referenceDocument. Reference
AdverseEvent study AdverseEvent.study. Reference
AdverseEvent_Causality id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AdverseEvent_Causality extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AdverseEvent_Causality modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AdverseEvent_Causality assessment Assessment of if the entity caused the event. CodeableConcept
AdverseEvent_Causality productRelatedness AdverseEvent.suspectEntity.causalityProductRelatedness. string
AdverseEvent_Causality _productRelatedness Extensions for productRelatedness Element
AdverseEvent_Causality author AdverseEvent.suspectEntity.causalityAuthor. Reference
AdverseEvent_Causality method ProbabilityScale | Bayesian | Checklist. CodeableConcept
AdverseEvent_SuspectEntity id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AdverseEvent_SuspectEntity extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AdverseEvent_SuspectEntity modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AdverseEvent_SuspectEntity instance Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device. Reference
AdverseEvent_SuspectEntity causality Information on the possible cause of the event. AdverseEvent_Causality
Age id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Age extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Age value The value of the measured amount. The value includes an implicit precision in the presentation of the value. decimal
Age _value Extensions for value Element
Age comparator 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. enum values:
<
<=
>=
>
Age _comparator Extensions for comparator Element
Age unit A human-readable form of the unit. string
Age _unit Extensions for unit Element
Age system The identification of the system that provides the coded form of the unit. uri
Age _system Extensions for system Element
Age code A computer processable form of the unit in some unit representation system. code
Age _code Extensions for code Element
AllergyIntolerance resourceType This is a AllergyIntolerance resource AllergyIntolerance
AllergyIntolerance id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
AllergyIntolerance meta 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. Meta
AllergyIntolerance implicitRules 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. uri
AllergyIntolerance _implicitRules Extensions for implicitRules Element
AllergyIntolerance language The base language in which the resource is written. code
AllergyIntolerance _language Extensions for language Element
AllergyIntolerance text 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. Narrative
AllergyIntolerance contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
AllergyIntolerance extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AllergyIntolerance modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AllergyIntolerance identifier 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. Identifier
AllergyIntolerance clinicalStatus The clinical status of the allergy or intolerance. CodeableConcept
AllergyIntolerance verificationStatus Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). CodeableConcept
AllergyIntolerance type Identification of the underlying physiological mechanism for the reaction risk. enum values:
allergy
intolerance
AllergyIntolerance _type Extensions for type Element
AllergyIntolerance category Category of the identified substance. enum values:
food
medication
environment
biologic
AllergyIntolerance _category Extensions for category Element
AllergyIntolerance criticality Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. enum values:
low
high
unable-to-assess
AllergyIntolerance _criticality Extensions for criticality Element
AllergyIntolerance 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. CodeableConcept
AllergyIntolerance patient The patient who has the allergy or intolerance. Reference
AllergyIntolerance encounter The encounter when the allergy or intolerance was asserted. Reference
AllergyIntolerance onsetDateTime Estimated or actual date, date-time, or age when allergy or intolerance was identified. notDefined
AllergyIntolerance _onsetDateTime Extensions for onsetDateTime Element
AllergyIntolerance onsetAge Estimated or actual date, date-time, or age when allergy or intolerance was identified. Age
AllergyIntolerance onsetPeriod Estimated or actual date, date-time, or age when allergy or intolerance was identified. Period
AllergyIntolerance onsetRange Estimated or actual date, date-time, or age when allergy or intolerance was identified. Range
AllergyIntolerance onsetString Estimated or actual date, date-time, or age when allergy or intolerance was identified. notDefined
AllergyIntolerance _onsetString Extensions for onsetString Element
AllergyIntolerance recordedDate The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. dateTime
AllergyIntolerance _recordedDate Extensions for recordedDate Element
AllergyIntolerance recorder Individual who recorded the record and takes responsibility for its content. Reference
AllergyIntolerance asserter The source of the information about the allergy that is recorded. Reference
AllergyIntolerance lastOccurrence Represents the date and/or time of the last known occurrence of a reaction event. dateTime
AllergyIntolerance _lastOccurrence Extensions for lastOccurrence Element
AllergyIntolerance note Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. Annotation
AllergyIntolerance reaction Details about each adverse reaction event linked to exposure to the identified substance. AllergyIntolerance_Reaction
AllergyIntolerance_Reaction id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AllergyIntolerance_Reaction extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AllergyIntolerance_Reaction modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AllergyIntolerance_Reaction substance 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. CodeableConcept
AllergyIntolerance_Reaction manifestation Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. CodeableConcept
AllergyIntolerance_Reaction description Text description about the reaction as a whole, including details of the manifestation if required. string
AllergyIntolerance_Reaction _description Extensions for description Element
AllergyIntolerance_Reaction onset Record of the date and/or time of the onset of the Reaction. dateTime
AllergyIntolerance_Reaction _onset Extensions for onset Element
AllergyIntolerance_Reaction severity Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. enum values:
mild
moderate
severe
AllergyIntolerance_Reaction _severity Extensions for severity Element
AllergyIntolerance_Reaction exposureRoute Identification of the route by which the subject was exposed to the substance. CodeableConcept
AllergyIntolerance_Reaction note Additional text about the adverse reaction event not captured in other fields. Annotation
Annotation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Annotation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Annotation authorReference The individual responsible for making the annotation. Reference
Annotation authorString The individual responsible for making the annotation. notDefined
Annotation _authorString Extensions for authorString Element
Annotation time Indicates when this particular annotation was made. dateTime
Annotation _time Extensions for time Element
Annotation text The text of the annotation in markdown format. markdown
Annotation _text Extensions for text Element
Appointment resourceType This is a Appointment resource Appointment
Appointment id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Appointment meta 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. Meta
Appointment implicitRules 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. uri
Appointment _implicitRules Extensions for implicitRules Element
Appointment language The base language in which the resource is written. code
Appointment _language Extensions for language Element
Appointment text 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. Narrative
Appointment contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Appointment extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Appointment modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Appointment identifier 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). Identifier
Appointment status 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. enum values:
proposed
pending
booked
arrived
fulfilled
cancelled
noshow
entered-in-error
checked-in
waitlist
Appointment _status Extensions for status Element
Appointment cancelationReason 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. CodeableConcept
Appointment serviceCategory A broad categorization of the service that is to be performed during this appointment. CodeableConcept
Appointment serviceType The specific service that is to be performed during this appointment. CodeableConcept
Appointment specialty The specialty of a practitioner that would be required to perform the service requested in this appointment. CodeableConcept
Appointment appointmentType The style of appointment or patient that has been booked in the slot (not service type). CodeableConcept
Appointment reasonCode The coded reason that this appointment is being scheduled. This is more clinical than administrative. CodeableConcept
Appointment reasonReference Reason the appointment has been scheduled to take place, 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. Reference
Appointment priority 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). unsignedInt
Appointment _priority Extensions for priority Element
Appointment description 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 comment field. string
Appointment _description Extensions for description Element
Appointment supportingInformation Additional information to support the appointment provided when making the appointment. Reference
Appointment start Date/Time that the appointment is to take place. instant
Appointment _start Extensions for start Element
Appointment end Date/Time that the appointment is to conclude. instant
Appointment _end Extensions for end Element
Appointment minutesDuration 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. positiveInt
Appointment _minutesDuration Extensions for minutesDuration Element
Appointment slot The slots from the participants' schedules that will be filled by the appointment. Reference
Appointment created 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. dateTime
Appointment _created Extensions for created Element
Appointment comment Additional comments about the appointment. string
Appointment _comment Extensions for comment Element
Appointment patientInstruction While Appointment.comment 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). string
Appointment _patientInstruction Extensions for patientInstruction Element
Appointment basedOn The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). Reference
Appointment participant List of participants involved in the appointment. Appointment_Participant
Appointment requestedPeriod 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. Period
AppointmentResponse resourceType This is a AppointmentResponse resource AppointmentResponse
AppointmentResponse id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
AppointmentResponse meta 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. Meta
AppointmentResponse implicitRules 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. uri
AppointmentResponse _implicitRules Extensions for implicitRules Element
AppointmentResponse language The base language in which the resource is written. code
AppointmentResponse _language Extensions for language Element
AppointmentResponse text 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. Narrative
AppointmentResponse contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
AppointmentResponse extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AppointmentResponse modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AppointmentResponse identifier 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. Identifier
AppointmentResponse appointment Appointment that this response is replying to. Reference
AppointmentResponse start Date/Time that the appointment is to take place, or requested new start time. instant
AppointmentResponse _start Extensions for start Element
AppointmentResponse end 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. instant
AppointmentResponse _end Extensions for end Element
AppointmentResponse participantType Role of participant in the appointment. CodeableConcept
AppointmentResponse actor A Person, Location, HealthcareService, or Device that is participating in the appointment. Reference
AppointmentResponse participantStatus 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. code
AppointmentResponse _participantStatus Extensions for participantStatus Element
AppointmentResponse comment Additional comments about the appointment. string
AppointmentResponse _comment Extensions for comment Element
Appointment_Participant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Appointment_Participant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Appointment_Participant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Appointment_Participant type Role of participant in the appointment. CodeableConcept
Appointment_Participant actor A Person, Location/HealthcareService or Device that is participating in the appointment. Reference
Appointment_Participant required Whether this participant is required to be present at the meeting. This covers a 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. enum values:
required
optional
information-only
Appointment_Participant _required Extensions for required Element
Appointment_Participant status Participation status of the actor. enum values:
accepted
declined
tentative
needs-action
Appointment_Participant _status Extensions for status Element
Appointment_Participant period Participation period of the actor. Period
Attachment id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Attachment extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Attachment contentType 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. code
Attachment _contentType Extensions for contentType Element
Attachment language The human language of the content. The value can be any valid value according to BCP 47. code
Attachment _language Extensions for language Element
Attachment data The actual data of the attachment - a sequence of bytes, base64 encoded. base64Binary
Attachment _data Extensions for data Element
Attachment url A location where the data can be accessed. url
Attachment _url Extensions for url Element
Attachment size The number of bytes of data that make up this attachment (before base64 encoding, if that is done). unsignedInt
Attachment _size Extensions for size Element
Attachment hash The calculated hash of the data using SHA-1. Represented using base64. base64Binary
Attachment _hash Extensions for hash Element
Attachment title A label or set of text to display in place of the data. string
Attachment _title Extensions for title Element
Attachment creation The date that the attachment was first created. dateTime
Attachment _creation Extensions for creation Element
AuditEvent resourceType This is a AuditEvent resource AuditEvent
AuditEvent id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
AuditEvent meta 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. Meta
AuditEvent implicitRules 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. uri
AuditEvent _implicitRules Extensions for implicitRules Element
AuditEvent language The base language in which the resource is written. code
AuditEvent _language Extensions for language Element
AuditEvent text 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. Narrative
AuditEvent contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
AuditEvent extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AuditEvent modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AuditEvent type Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. Coding
AuditEvent subtype Identifier for the category of event. Coding
AuditEvent action Indicator for type of action performed during the event that generated the audit. enum values:
C
R
U
D
E
AuditEvent _action Extensions for action Element
AuditEvent period The period during which the activity occurred. Period
AuditEvent recorded The time when the event was recorded. instant
AuditEvent _recorded Extensions for recorded Element
AuditEvent outcome Indicates whether the event succeeded or failed. enum values:
0
4
8
12
AuditEvent _outcome Extensions for outcome Element
AuditEvent outcomeDesc A free text description of the outcome of the event. string
AuditEvent _outcomeDesc Extensions for outcomeDesc Element
AuditEvent purposeOfEvent The purposeOfUse (reason) that was used during the event being recorded. CodeableConcept
AuditEvent agent An actor taking an active role in the event or activity that is logged. AuditEvent_Agent
AuditEvent source The system that is reporting the event. AuditEvent_Source
AuditEvent entity Specific instances of data or objects that have been accessed. AuditEvent_Entity
AuditEvent_Agent id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AuditEvent_Agent extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AuditEvent_Agent modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AuditEvent_Agent type Specification of the participation type the user plays when performing the event. CodeableConcept
AuditEvent_Agent role The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. CodeableConcept
AuditEvent_Agent who Reference to who this agent is that was involved in the event. Reference
AuditEvent_Agent altId Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available. string
AuditEvent_Agent _altId Extensions for altId Element
AuditEvent_Agent name Human-meaningful name for the agent. string
AuditEvent_Agent _name Extensions for name Element
AuditEvent_Agent requestor Indicator that the user is or is not the requestor, or initiator, for the event being audited. boolean
AuditEvent_Agent _requestor Extensions for requestor Element
AuditEvent_Agent location Where the event occurred. Reference
AuditEvent_Agent policy The policy or plan that authorized the activity being recorded. 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. uri
AuditEvent_Agent _policy Extensions for policy Element
AuditEvent_Agent media Type of media involved. Used when the event is about exporting/importing onto media. Coding
AuditEvent_Agent network Logical network location for application activity, if the activity has a network location. AuditEvent_Network
AuditEvent_Agent purposeOfUse The reason (purpose of use), specific to this agent, that was used during the event being recorded. CodeableConcept
AuditEvent_Detail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AuditEvent_Detail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AuditEvent_Detail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AuditEvent_Detail type The type of extra detail provided in the value. string
AuditEvent_Detail _type Extensions for type Element
AuditEvent_Detail valueString The value of the extra detail. notDefined
AuditEvent_Detail _valueString Extensions for valueString Element
AuditEvent_Detail valueBase64Binary The value of the extra detail. notDefined
AuditEvent_Detail _valueBase64Binary Extensions for valueBase64Binary Element
AuditEvent_Entity id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AuditEvent_Entity extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AuditEvent_Entity modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AuditEvent_Entity what Identifies a specific instance of the entity. The reference should be version specific. Reference
AuditEvent_Entity type The type of the object that was involved in this audit event. Coding
AuditEvent_Entity role Code representing the role the entity played in the event being audited. Coding
AuditEvent_Entity lifecycle Identifier for the data life-cycle stage for the entity. Coding
AuditEvent_Entity securityLabel Security labels for the identified entity. Coding
AuditEvent_Entity name A name of the entity in the audit event. string
AuditEvent_Entity _name Extensions for name Element
AuditEvent_Entity description Text that describes the entity in more detail. string
AuditEvent_Entity _description Extensions for description Element
AuditEvent_Entity query The query parameters for a query-type entities. base64Binary
AuditEvent_Entity _query Extensions for query Element
AuditEvent_Entity detail Tagged value pairs for conveying additional information about the entity. AuditEvent_Detail
AuditEvent_Network id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AuditEvent_Network extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AuditEvent_Network modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AuditEvent_Network address An identifier for the network access point of the user device for the audit event. string
AuditEvent_Network _address Extensions for address Element
AuditEvent_Network type An identifier for the type of network access point that originated the audit event. enum values:
1
2
3
4
5
AuditEvent_Network _type Extensions for type Element
AuditEvent_Source id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
AuditEvent_Source extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
AuditEvent_Source modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
AuditEvent_Source site Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. string
AuditEvent_Source _site Extensions for site Element
AuditEvent_Source observer Identifier of the source where the event was detected. Reference
AuditEvent_Source type Code specifying the type of source where event originated. Coding
Basic resourceType This is a Basic resource Basic
Basic id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Basic meta 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. Meta
Basic implicitRules 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. uri
Basic _implicitRules Extensions for implicitRules Element
Basic language The base language in which the resource is written. code
Basic _language Extensions for language Element
Basic text 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. Narrative
Basic contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Basic extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Basic modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Basic identifier Identifier assigned to the resource for business purposes, outside the context of FHIR. Identifier
Basic code Identifies the 'type' of resource - equivalent to the resource name for other resources. CodeableConcept
Basic subject Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. Reference
Basic created Identifies when the resource was first created. date
Basic _created Extensions for created Element
Basic author Indicates who was responsible for creating the resource instance. Reference
Binary resourceType This is a Binary resource Binary
Binary id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Binary meta 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. Meta
Binary implicitRules 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. uri
Binary _implicitRules Extensions for implicitRules Element
Binary language The base language in which the resource is written. code
Binary _language Extensions for language Element
Binary contentType MimeType of the binary content represented as a standard MimeType (BCP 13). code
Binary _contentType Extensions for contentType Element
Binary securityContext 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. Media, 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. Reference
Binary data The actual content, base64 encoded. base64Binary
Binary _data Extensions for data Element
BiologicallyDerivedProduct resourceType This is a BiologicallyDerivedProduct resource BiologicallyDerivedProduct
BiologicallyDerivedProduct id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
BiologicallyDerivedProduct meta 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. Meta
BiologicallyDerivedProduct implicitRules 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. uri
BiologicallyDerivedProduct _implicitRules Extensions for implicitRules Element
BiologicallyDerivedProduct language The base language in which the resource is written. code
BiologicallyDerivedProduct _language Extensions for language Element
BiologicallyDerivedProduct text 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. Narrative
BiologicallyDerivedProduct contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
BiologicallyDerivedProduct extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
BiologicallyDerivedProduct modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
BiologicallyDerivedProduct identifier This records identifiers associated with this biologically derived product instance 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). Identifier
BiologicallyDerivedProduct productCategory Broad category of this product. enum values:
organ
tissue
fluid
cells
biologicalAgent
BiologicallyDerivedProduct _productCategory Extensions for productCategory Element
BiologicallyDerivedProduct productCode A code that identifies the kind of this biologically derived product (SNOMED Ctcode). CodeableConcept
BiologicallyDerivedProduct status Whether the product is currently available. enum values:
available
unavailable
BiologicallyDerivedProduct _status Extensions for status Element
BiologicallyDerivedProduct request Procedure request to obtain this biologically derived product. Reference
BiologicallyDerivedProduct quantity Number of discrete units within this product. integer
BiologicallyDerivedProduct _quantity Extensions for quantity Element
BiologicallyDerivedProduct parent Parent product (if any). Reference
BiologicallyDerivedProduct collection How this product was collected. BiologicallyDerivedProduct_Collection
BiologicallyDerivedProduct processing Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells. BiologicallyDerivedProduct_Processing
BiologicallyDerivedProduct manipulation Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion. BiologicallyDerivedProduct_Manipulation
BiologicallyDerivedProduct storage Product storage. BiologicallyDerivedProduct_Storage
BiologicallyDerivedProduct_Collection id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
BiologicallyDerivedProduct_Collection extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
BiologicallyDerivedProduct_Collection modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
BiologicallyDerivedProduct_Collection collector Healthcare professional who is performing the collection. Reference
BiologicallyDerivedProduct_Collection source The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product. Reference
BiologicallyDerivedProduct_Collection collectedDateTime Time of product collection. notDefined
BiologicallyDerivedProduct_Collection _collectedDateTime Extensions for collectedDateTime Element
BiologicallyDerivedProduct_Collection collectedPeriod Time of product collection. Period
BiologicallyDerivedProduct_Manipulation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
BiologicallyDerivedProduct_Manipulation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
BiologicallyDerivedProduct_Manipulation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
BiologicallyDerivedProduct_Manipulation description Description of manipulation. string
BiologicallyDerivedProduct_Manipulation _description Extensions for description Element
BiologicallyDerivedProduct_Manipulation timeDateTime Time of manipulation. notDefined
BiologicallyDerivedProduct_Manipulation _timeDateTime Extensions for timeDateTime Element
BiologicallyDerivedProduct_Manipulation timePeriod Time of manipulation. Period
BiologicallyDerivedProduct_Processing id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
BiologicallyDerivedProduct_Processing extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
BiologicallyDerivedProduct_Processing modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
BiologicallyDerivedProduct_Processing description Description of of processing. string
BiologicallyDerivedProduct_Processing _description Extensions for description Element
BiologicallyDerivedProduct_Processing procedure Procesing code. CodeableConcept
BiologicallyDerivedProduct_Processing additive Substance added during processing. Reference
BiologicallyDerivedProduct_Processing timeDateTime Time of processing. notDefined
BiologicallyDerivedProduct_Processing _timeDateTime Extensions for timeDateTime Element
BiologicallyDerivedProduct_Processing timePeriod Time of processing. Period
BiologicallyDerivedProduct_Storage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
BiologicallyDerivedProduct_Storage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
BiologicallyDerivedProduct_Storage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
BiologicallyDerivedProduct_Storage description Description of storage. string
BiologicallyDerivedProduct_Storage _description Extensions for description Element
BiologicallyDerivedProduct_Storage temperature Storage temperature. decimal
BiologicallyDerivedProduct_Storage _temperature Extensions for temperature Element
BiologicallyDerivedProduct_Storage scale Temperature scale used. enum values:
farenheit
celsius
kelvin
BiologicallyDerivedProduct_Storage _scale Extensions for scale Element
BiologicallyDerivedProduct_Storage duration Storage timeperiod. Period
BodyStructure resourceType This is a BodyStructure resource BodyStructure
BodyStructure id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
BodyStructure meta 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. Meta
BodyStructure implicitRules 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. uri
BodyStructure _implicitRules Extensions for implicitRules Element
BodyStructure language The base language in which the resource is written. code
BodyStructure _language Extensions for language Element
BodyStructure text 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. Narrative
BodyStructure contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
BodyStructure extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
BodyStructure modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
BodyStructure identifier Identifier for this instance of the anatomical structure. Identifier
BodyStructure active Whether this body site is in active use. boolean
BodyStructure _active Extensions for active Element
BodyStructure morphology The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies. CodeableConcept
BodyStructure location The anatomical location or region of the specimen, lesion, or body structure. CodeableConcept
BodyStructure locationQualifier Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. CodeableConcept
BodyStructure description A summary, characterization or explanation of the body structure. string
BodyStructure _description Extensions for description Element
BodyStructure image Image or images used to identify a location. Attachment
BodyStructure patient The person to which the body site belongs. Reference
Bundle resourceType This is a Bundle resource Bundle
Bundle id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Bundle meta 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. Meta
Bundle implicitRules 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. uri
Bundle _implicitRules Extensions for implicitRules Element
Bundle language The base language in which the resource is written. code
Bundle _language Extensions for language Element
Bundle identifier A persistent identifier for the bundle that won't change as a bundle is copied from server to server. Identifier
Bundle type Indicates the purpose of this bundle - how it is intended to be used. enum values:
document
message
transaction
transaction-response
batch
batch-response
history
searchset
collection
Bundle _type Extensions for type Element
Bundle timestamp The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. instant
Bundle _timestamp Extensions for timestamp Element
Bundle total If a set of search matches, this is the 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. unsignedInt
Bundle _total Extensions for total Element
Bundle link A series of links that provide context to this bundle. Bundle_Link
Bundle entry An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). Bundle_Entry
Bundle signature Digital Signature - base64 encoded. XML-DSig or a JWT. Signature
Bundle_Entry id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Bundle_Entry extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Bundle_Entry modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Bundle_Entry link A series of links that provide context to this entry. Bundle_Link
Bundle_Entry fullUrl The Absolute URL for the resource. 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. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified. uri
Bundle_Entry _fullUrl Extensions for fullUrl Element
Bundle_Entry resource The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. ResourceList
Bundle_Entry search Information about the search process that lead to the creation of this entry. Bundle_Search
Bundle_Entry request 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_Request
Bundle_Entry response 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_Response
Bundle_Link id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Bundle_Link extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Bundle_Link modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Bundle_Link relation 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). string
Bundle_Link _relation Extensions for relation Element
Bundle_Link url The reference details for the link. uri
Bundle_Link _url Extensions for url Element
Bundle_Request id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Bundle_Request extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Bundle_Request modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Bundle_Request method 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. enum values:
GET
HEAD
POST
PUT
DELETE
PATCH
Bundle_Request _method Extensions for method Element
Bundle_Request url The URL for this entry, relative to the root (the address to which the request is posted). uri
Bundle_Request _url Extensions for url Element
Bundle_Request ifNoneMatch If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread). string
Bundle_Request _ifNoneMatch Extensions for ifNoneMatch Element
Bundle_Request ifModifiedSince Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread). instant
Bundle_Request _ifModifiedSince Extensions for ifModifiedSince Element
Bundle_Request ifMatch Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency). string
Bundle_Request _ifMatch Extensions for ifMatch Element
Bundle_Request ifNoneExist 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 "?"). string
Bundle_Request _ifNoneExist Extensions for ifNoneExist Element
Bundle_Response id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Bundle_Response extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Bundle_Response modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Bundle_Response status 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. string
Bundle_Response _status Extensions for status Element
Bundle_Response location The location header created by processing this operation, populated if the operation returns a location. uri
Bundle_Response _location Extensions for location Element
Bundle_Response etag 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)). string
Bundle_Response _etag Extensions for etag Element
Bundle_Response lastModified The date/time that the resource was modified on the server. instant
Bundle_Response _lastModified Extensions for lastModified Element
Bundle_Response outcome An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. ResourceList
Bundle_Search id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Bundle_Search extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Bundle_Search modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Bundle_Search mode 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. enum values:
match
include
outcome
Bundle_Search _mode Extensions for mode Element
Bundle_Search score When searching, the server's search ranking score for the entry. decimal
Bundle_Search _score Extensions for score Element
CapabilityStatement resourceType This is a CapabilityStatement resource CapabilityStatement
CapabilityStatement id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CapabilityStatement meta 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. Meta
CapabilityStatement implicitRules 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. uri
CapabilityStatement _implicitRules Extensions for implicitRules Element
CapabilityStatement language The base language in which the resource is written. code
CapabilityStatement _language Extensions for language Element
CapabilityStatement text 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. Narrative
CapabilityStatement contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CapabilityStatement extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement url 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 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. uri
CapabilityStatement _url Extensions for url Element
CapabilityStatement version 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. string
CapabilityStatement _version Extensions for version Element
CapabilityStatement name 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. string
CapabilityStatement _name Extensions for name Element
CapabilityStatement title A short, descriptive, user-friendly title for the capability statement. string
CapabilityStatement _title Extensions for title Element
CapabilityStatement status The status of this capability statement. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
CapabilityStatement _status Extensions for status Element
CapabilityStatement experimental 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. boolean
CapabilityStatement _experimental Extensions for experimental Element
CapabilityStatement date The date (and optionally time) when the capability statement 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 capability statement changes. dateTime
CapabilityStatement _date Extensions for date Element
CapabilityStatement publisher The name of the organization or individual that published the capability statement. string
CapabilityStatement _publisher Extensions for publisher Element
CapabilityStatement contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
CapabilityStatement description 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. markdown
CapabilityStatement _description Extensions for description Element
CapabilityStatement useContext 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. UsageContext
CapabilityStatement jurisdiction A legal or geographic region in which the capability statement is intended to be used. CodeableConcept
CapabilityStatement purpose Explanation of why this capability statement is needed and why it has been designed as it has. markdown
CapabilityStatement _purpose Extensions for purpose Element
CapabilityStatement copyright 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. markdown
CapabilityStatement _copyright Extensions for copyright Element
CapabilityStatement kind 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). enum values:
instance
capability
requirements
CapabilityStatement _kind Extensions for kind Element
CapabilityStatement instantiates 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. canonical
CapabilityStatement imports 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. canonical
CapabilityStatement software 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
CapabilityStatement implementation 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
CapabilityStatement fhirVersion 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. enum values:
0.01
0.05
0.06
0.11
0.0.80
0.0.81
0.0.82
0.4.0
0.5.0
1.0.0
1.0.1
1.0.2
1.1.0
1.4.0
1.6.0
1.8.0
3.0.0
3.0.1
3.3.0
3.5.0
4.0.0
CapabilityStatement _fhirVersion Extensions for fhirVersion Element
CapabilityStatement format A list of the formats supported by this implementation using their content types. code
CapabilityStatement _format Extensions for format Element
CapabilityStatement patchFormat A list of the patch formats supported by this implementation using their content types. code
CapabilityStatement _patchFormat Extensions for patchFormat Element
CapabilityStatement implementationGuide A list of implementation guides that the server does (or should) support in their entirety. canonical
CapabilityStatement rest A definition of the restful capabilities of the solution, if any. CapabilityStatement_Rest
CapabilityStatement messaging A description of the messaging capabilities of the solution. CapabilityStatement_Messaging
CapabilityStatement document A document definition. CapabilityStatement_Document
CapabilityStatement_Document id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Document extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Document modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Document mode Mode of this document declaration - whether an application is a producer or consumer. enum values:
producer
consumer
CapabilityStatement_Document _mode Extensions for mode Element
CapabilityStatement_Document documentation 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. markdown
CapabilityStatement_Document _documentation Extensions for documentation Element
CapabilityStatement_Document profile A profile on the document Bundle that constrains which resources are present, and their contents. canonical
CapabilityStatement_Endpoint id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Endpoint extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Endpoint modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Endpoint protocol A list of the messaging transport protocol(s) identifiers, supported by this endpoint. Coding
CapabilityStatement_Endpoint address The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier. url
CapabilityStatement_Endpoint _address Extensions for address Element
CapabilityStatement_Implementation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Implementation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Implementation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Implementation description Information about the specific installation that this capability statement relates to. string
CapabilityStatement_Implementation _description Extensions for description Element
CapabilityStatement_Implementation url An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. url
CapabilityStatement_Implementation _url Extensions for url Element
CapabilityStatement_Implementation custodian The organization responsible for the management of the instance and oversight of the data on the server at the specified URL. Reference
CapabilityStatement_Interaction id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Interaction extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Interaction modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Interaction code Coded identifier of the operation, supported by the system resource. enum values:
read
vread
update
patch
delete
history-instance
history-type
create
search-type
CapabilityStatement_Interaction _code Extensions for code Element
CapabilityStatement_Interaction documentation 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'. markdown
CapabilityStatement_Interaction _documentation Extensions for documentation Element
CapabilityStatement_Interaction1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Interaction1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Interaction1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Interaction1 code A coded identifier of the operation, supported by the system. enum values:
transaction
batch
search-system
history-system
CapabilityStatement_Interaction1 _code Extensions for code Element
CapabilityStatement_Interaction1 documentation 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. markdown
CapabilityStatement_Interaction1 _documentation Extensions for documentation Element
CapabilityStatement_Messaging id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Messaging extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Messaging modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Messaging endpoint An endpoint (network accessible address) to which messages and/or replies are to be sent. CapabilityStatement_Endpoint
CapabilityStatement_Messaging reliableCache 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). unsignedInt
CapabilityStatement_Messaging _reliableCache Extensions for reliableCache Element
CapabilityStatement_Messaging documentation 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. markdown
CapabilityStatement_Messaging _documentation Extensions for documentation Element
CapabilityStatement_Messaging supportedMessage References to message definitions for messages this system can send or receive. CapabilityStatement_SupportedMessage
CapabilityStatement_Operation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Operation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Operation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Operation name The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. string
CapabilityStatement_Operation _name Extensions for name Element
CapabilityStatement_Operation definition 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]]] with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported. canonical
CapabilityStatement_Operation documentation Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation. markdown
CapabilityStatement_Operation _documentation Extensions for documentation Element
CapabilityStatement_Resource id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Resource extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Resource modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Resource type A type of resource exposed via the restful interface. code
CapabilityStatement_Resource _type Extensions for type Element
CapabilityStatement_Resource profile A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses). canonical
CapabilityStatement_Resource supportedProfile A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses). canonical
CapabilityStatement_Resource documentation Additional information about the resource type used by the system. markdown
CapabilityStatement_Resource _documentation Extensions for documentation Element
CapabilityStatement_Resource interaction Identifies a restful operation supported by the solution. CapabilityStatement_Interaction
CapabilityStatement_Resource versioning 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. enum values:
no-version
versioned
versioned-update
CapabilityStatement_Resource _versioning Extensions for versioning Element
CapabilityStatement_Resource readHistory A flag for whether the server is able to return past versions as part of the vRead operation. boolean
CapabilityStatement_Resource _readHistory Extensions for readHistory Element
CapabilityStatement_Resource updateCreate 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. boolean
CapabilityStatement_Resource _updateCreate Extensions for updateCreate Element
CapabilityStatement_Resource conditionalCreate A flag that indicates that the server supports conditional create. boolean
CapabilityStatement_Resource _conditionalCreate Extensions for conditionalCreate Element
CapabilityStatement_Resource conditionalRead A code that indicates how the server supports conditional read. enum values:
not-supported
modified-since
not-match
full-support
CapabilityStatement_Resource _conditionalRead Extensions for conditionalRead Element
CapabilityStatement_Resource conditionalUpdate A flag that indicates that the server supports conditional update. boolean
CapabilityStatement_Resource _conditionalUpdate Extensions for conditionalUpdate Element
CapabilityStatement_Resource conditionalDelete A code that indicates how the server supports conditional delete. enum values:
not-supported
single
multiple
CapabilityStatement_Resource _conditionalDelete Extensions for conditionalDelete Element
CapabilityStatement_Resource referencePolicy A set of flags that defines how references are supported. enum values:
literal
logical
resolves
enforced
local
CapabilityStatement_Resource _referencePolicy Extensions for referencePolicy Element
CapabilityStatement_Resource searchInclude A list of _include values supported by the server. string
CapabilityStatement_Resource _searchInclude Extensions for searchInclude Element
CapabilityStatement_Resource searchRevInclude A list of _revinclude (reverse include) values supported by the server. string
CapabilityStatement_Resource _searchRevInclude Extensions for searchRevInclude Element
CapabilityStatement_Resource searchParam 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. CapabilityStatement_SearchParam
CapabilityStatement_Resource operation 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. CapabilityStatement_Operation
CapabilityStatement_Rest id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Rest extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Rest modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Rest mode Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations. enum values:
client
server
CapabilityStatement_Rest _mode Extensions for mode Element
CapabilityStatement_Rest documentation Information about the system's restful capabilities that apply across all applications, such as security. markdown
CapabilityStatement_Rest _documentation Extensions for documentation Element
CapabilityStatement_Rest security Information about security implementation from an interface perspective - what a client needs to know. CapabilityStatement_Security
CapabilityStatement_Rest resource A specification of the restful capabilities of the solution for a specific resource type. CapabilityStatement_Resource
CapabilityStatement_Rest interaction A specification of restful operations supported by the system. CapabilityStatement_Interaction1
CapabilityStatement_Rest searchParam 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. CapabilityStatement_SearchParam
CapabilityStatement_Rest operation Definition of an operation or a named query together with its parameters and their meaning and type. CapabilityStatement_Operation
CapabilityStatement_Rest compartment 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 . canonical
CapabilityStatement_SearchParam id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_SearchParam extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_SearchParam modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_SearchParam name The name of the search parameter used in the interface. string
CapabilityStatement_SearchParam _name Extensions for name Element
CapabilityStatement_SearchParam definition 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]]]). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs. canonical
CapabilityStatement_SearchParam type The type of value a search parameter refers to, and how the content is interpreted. enum values:
number
date
string
token
reference
composite
quantity
uri
special
CapabilityStatement_SearchParam _type Extensions for type Element
CapabilityStatement_SearchParam documentation This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. markdown
CapabilityStatement_SearchParam _documentation Extensions for documentation Element
CapabilityStatement_Security id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Security extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Security modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Security cors Server adds CORS headers when responding to requests - this enables Javascript applications to use the server. boolean
CapabilityStatement_Security _cors Extensions for cors Element
CapabilityStatement_Security service Types of security services that are supported/required by the system. CodeableConcept
CapabilityStatement_Security description General description of how security works. markdown
CapabilityStatement_Security _description Extensions for description Element
CapabilityStatement_Software id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_Software extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_Software modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_Software name Name the software is known by. string
CapabilityStatement_Software _name Extensions for name Element
CapabilityStatement_Software version The version identifier for the software covered by this statement. string
CapabilityStatement_Software _version Extensions for version Element
CapabilityStatement_Software releaseDate Date this version of the software was released. dateTime
CapabilityStatement_Software _releaseDate Extensions for releaseDate Element
CapabilityStatement_SupportedMessage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CapabilityStatement_SupportedMessage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CapabilityStatement_SupportedMessage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CapabilityStatement_SupportedMessage mode The mode of this event declaration - whether application is sender or receiver. enum values:
sender
receiver
CapabilityStatement_SupportedMessage _mode Extensions for mode Element
CapabilityStatement_SupportedMessage definition Points to a message definition that identifies the messaging event, message structure, allowed responses, etc. canonical
CarePlan resourceType This is a CarePlan resource CarePlan
CarePlan id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CarePlan meta 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. Meta
CarePlan implicitRules 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. uri
CarePlan _implicitRules Extensions for implicitRules Element
CarePlan language The base language in which the resource is written. code
CarePlan _language Extensions for language Element
CarePlan text 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. Narrative
CarePlan contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CarePlan extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CarePlan modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CarePlan identifier 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. Identifier
CarePlan instantiatesCanonical 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. canonical
CarePlan instantiatesUri 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. uri
CarePlan _instantiatesUri Extensions for instantiatesUri Element
CarePlan basedOn A care plan that is fulfilled in whole or in part by this care plan. Reference
CarePlan replaces Completed or terminated care plan whose function is taken by this new care plan. Reference
CarePlan partOf A larger care plan of which this particular care plan is a component or step. Reference
CarePlan status Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. code
CarePlan _status Extensions for status Element
CarePlan intent Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. code
CarePlan _intent Extensions for intent Element
CarePlan category 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. CodeableConcept
CarePlan title Human-friendly name for the care plan. string
CarePlan _title Extensions for title Element
CarePlan description A description of the scope and nature of the plan. string
CarePlan _description Extensions for description Element
CarePlan subject Identifies the patient or group whose intended care is described by the plan. Reference
CarePlan encounter The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. Reference
CarePlan period Indicates when the plan did (or is intended to) come into effect and end. Period
CarePlan created Represents when this particular CarePlan record was created in the system, which is often a system-generated date. dateTime
CarePlan _created Extensions for created Element
CarePlan author When populated, the author is responsible for the care plan. The care plan is attributed to the author. Reference
CarePlan contributor Identifies the individual(s) or organization who provided the contents of the care plan. Reference
CarePlan careTeam Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. Reference
CarePlan addresses Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. Reference
CarePlan supportingInfo 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. Reference
CarePlan goal Describes the intended objective(s) of carrying out the care plan. Reference
CarePlan activity Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc. CarePlan_Activity
CarePlan note General notes about the care plan not covered elsewhere. Annotation
CarePlan_Activity id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CarePlan_Activity extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CarePlan_Activity modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CarePlan_Activity outcomeCodeableConcept Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). CodeableConcept
CarePlan_Activity outcomeReference Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). Reference
CarePlan_Activity progress Notes about the adherence/status/progress of the activity. Annotation
CarePlan_Activity reference The details of the proposed activity represented in a specific resource. Reference
CarePlan_Activity detail A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc. CarePlan_Detail
CarePlan_Detail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CarePlan_Detail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CarePlan_Detail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CarePlan_Detail kind A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. code
CarePlan_Detail _kind Extensions for kind Element
CarePlan_Detail instantiatesCanonical 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 activity. canonical
CarePlan_Detail instantiatesUri 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 activity. uri
CarePlan_Detail _instantiatesUri Extensions for instantiatesUri Element
CarePlan_Detail code Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. CodeableConcept
CarePlan_Detail reasonCode Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. CodeableConcept
CarePlan_Detail reasonReference Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. Reference
CarePlan_Detail goal Internal reference that identifies the goals that this activity is intended to contribute towards meeting. Reference
CarePlan_Detail status Identifies what progress is being made for the specific activity. enum values:
not-started
scheduled
in-progress
on-hold
completed
cancelled
stopped
unknown
entered-in-error
CarePlan_Detail _status Extensions for status Element
CarePlan_Detail statusReason Provides reason why the activity isn't yet started, is on hold, was cancelled, etc. CodeableConcept
CarePlan_Detail doNotPerform If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. boolean
CarePlan_Detail _doNotPerform Extensions for doNotPerform Element
CarePlan_Detail scheduledTiming The period, timing or frequency upon which the described activity is to occur. Timing
CarePlan_Detail scheduledPeriod The period, timing or frequency upon which the described activity is to occur. Period
CarePlan_Detail scheduledString The period, timing or frequency upon which the described activity is to occur. notDefined
CarePlan_Detail _scheduledString Extensions for scheduledString Element
CarePlan_Detail location Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Reference
CarePlan_Detail performer Identifies who's expected to be involved in the activity. Reference
CarePlan_Detail productCodeableConcept Identifies the food, drug or other product to be consumed or supplied in the activity. CodeableConcept
CarePlan_Detail productReference Identifies the food, drug or other product to be consumed or supplied in the activity. Reference
CarePlan_Detail dailyAmount Identifies the quantity expected to be consumed in a given day. Quantity
CarePlan_Detail quantity Identifies the quantity expected to be supplied, administered or consumed by the subject. Quantity
CarePlan_Detail description This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc. string
CarePlan_Detail _description Extensions for description Element
CareTeam resourceType This is a CareTeam resource CareTeam
CareTeam id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CareTeam meta 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. Meta
CareTeam implicitRules 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. uri
CareTeam _implicitRules Extensions for implicitRules Element
CareTeam language The base language in which the resource is written. code
CareTeam _language Extensions for language Element
CareTeam text 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. Narrative
CareTeam contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CareTeam extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CareTeam modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CareTeam identifier 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. Identifier
CareTeam status Indicates the current state of the care team. enum values:
proposed
active
suspended
inactive
entered-in-error
CareTeam _status Extensions for status Element
CareTeam category 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. CodeableConcept
CareTeam name A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams. string
CareTeam _name Extensions for name Element
CareTeam subject Identifies the patient or group whose intended care is handled by the team. Reference
CareTeam encounter The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated. Reference
CareTeam period Indicates when the team did (or is intended to) come into effect and end. Period
CareTeam participant Identifies all people and organizations who are expected to be involved in the care team. CareTeam_Participant
CareTeam reasonCode Describes why the care team exists. CodeableConcept
CareTeam reasonReference Condition(s) that this care team addresses. Reference
CareTeam managingOrganization The organization responsible for the care team. Reference
CareTeam telecom A central contact detail for the care team (that applies to all members). ContactPoint
CareTeam note Comments made about the CareTeam. Annotation
CareTeam_Participant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CareTeam_Participant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CareTeam_Participant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CareTeam_Participant role Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc. CodeableConcept
CareTeam_Participant member The specific person or organization who is participating/expected to participate in the care team. Reference
CareTeam_Participant onBehalfOf The organization of the practitioner. Reference
CareTeam_Participant period Indicates when the specific member or organization did (or is intended to) come into effect and end. Period
CatalogEntry resourceType This is a CatalogEntry resource CatalogEntry
CatalogEntry id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CatalogEntry meta 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. Meta
CatalogEntry implicitRules 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. uri
CatalogEntry _implicitRules Extensions for implicitRules Element
CatalogEntry language The base language in which the resource is written. code
CatalogEntry _language Extensions for language Element
CatalogEntry text 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. Narrative
CatalogEntry contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CatalogEntry extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CatalogEntry modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CatalogEntry identifier Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code. Identifier
CatalogEntry type The type of item - medication, device, service, protocol or other. CodeableConcept
CatalogEntry orderable Whether the entry represents an orderable item. boolean
CatalogEntry _orderable Extensions for orderable Element
CatalogEntry referencedItem The item in a catalog or definition. Reference
CatalogEntry additionalIdentifier Used in supporting related concepts, e.g. NDC to RxNorm. Identifier
CatalogEntry classification Classes of devices, or ATC for medication. CodeableConcept
CatalogEntry status Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable. enum values:
draft
active
retired
unknown
CatalogEntry _status Extensions for status Element
CatalogEntry validityPeriod The time period in which this catalog entry is expected to be active. Period
CatalogEntry validTo The date until which this catalog entry is expected to be active. dateTime
CatalogEntry _validTo Extensions for validTo Element
CatalogEntry lastUpdated Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated. dateTime
CatalogEntry _lastUpdated Extensions for lastUpdated Element
CatalogEntry additionalCharacteristic Used for examplefor Out of Formulary, or any specifics. CodeableConcept
CatalogEntry additionalClassification User for example for ATC classification, or. CodeableConcept
CatalogEntry relatedEntry Used for example, to point to a substance, or to a device used to administer a medication. CatalogEntry_RelatedEntry
CatalogEntry_RelatedEntry id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CatalogEntry_RelatedEntry extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CatalogEntry_RelatedEntry modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CatalogEntry_RelatedEntry relationtype The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc. enum values:
triggers
is-replaced-by
CatalogEntry_RelatedEntry _relationtype Extensions for relationtype Element
CatalogEntry_RelatedEntry item The reference to the related item. Reference
ChargeItem resourceType This is a ChargeItem resource ChargeItem
ChargeItem id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ChargeItem meta 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. Meta
ChargeItem implicitRules 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. uri
ChargeItem _implicitRules Extensions for implicitRules Element
ChargeItem language The base language in which the resource is written. code
ChargeItem _language Extensions for language Element
ChargeItem text 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. Narrative
ChargeItem contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ChargeItem extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ChargeItem modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ChargeItem identifier Identifiers assigned to this event performer or other systems. Identifier
ChargeItem definitionUri References the (external) source of pricing information, rules of application for the code this ChargeItem uses. uri
ChargeItem _definitionUri Extensions for definitionUri Element
ChargeItem definitionCanonical References the source of pricing information, rules of application for the code this ChargeItem uses. canonical
ChargeItem status The current state of the ChargeItem. enum values:
planned
billable
not-billable
aborted
billed
entered-in-error
unknown
ChargeItem _status Extensions for status Element
ChargeItem partOf ChargeItems can be grouped to larger ChargeItems covering the whole set. Reference
ChargeItem code A code that identifies the charge, like a billing code. CodeableConcept
ChargeItem subject The individual or set of individuals the action is being or was performed on. Reference
ChargeItem context The encounter or episode of care that establishes the context for this event. Reference
ChargeItem occurrenceDateTime Date/time(s) or duration when the charged service was applied. notDefined
ChargeItem _occurrenceDateTime Extensions for occurrenceDateTime Element
ChargeItem occurrencePeriod Date/time(s) or duration when the charged service was applied. Period
ChargeItem occurrenceTiming Date/time(s) or duration when the charged service was applied. Timing
ChargeItem performer Indicates who or what performed or participated in the charged service. ChargeItem_Performer
ChargeItem performingOrganization The organization requesting the service. Reference
ChargeItem requestingOrganization The organization performing the service. Reference
ChargeItem costCenter The financial cost center permits the tracking of charge attribution. Reference
ChargeItem quantity Quantity of which the charge item has been serviced. Quantity
ChargeItem bodysite The anatomical location where the related service has been applied. CodeableConcept
ChargeItem factorOverride Factor overriding the factor determined by the rules associated with the code. decimal
ChargeItem _factorOverride Extensions for factorOverride Element
ChargeItem priceOverride Total price of the charge overriding the list price associated with the code. Money
ChargeItem overrideReason 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. string
ChargeItem _overrideReason Extensions for overrideReason Element
ChargeItem enterer The device, practitioner, etc. who entered the charge item. Reference
ChargeItem enteredDate Date the charge item was entered. dateTime
ChargeItem _enteredDate Extensions for enteredDate Element
ChargeItem reason Describes why the event occurred in coded or textual form. CodeableConcept
ChargeItem service Indicated the rendered service that caused this charge. Reference
ChargeItem productReference Identifies the device, food, drug or other product being charged either by type code or reference to an instance. Reference
ChargeItem productCodeableConcept Identifies the device, food, drug or other product being charged either by type code or reference to an instance. CodeableConcept
ChargeItem account Account into which this ChargeItems belongs. Reference
ChargeItem note Comments made about the event by the performer, subject or other participants. Annotation
ChargeItem supportingInformation Further information supporting this charge. Reference
ChargeItemDefinition resourceType This is a ChargeItemDefinition resource ChargeItemDefinition
ChargeItemDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ChargeItemDefinition meta 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. Meta
ChargeItemDefinition implicitRules 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. uri
ChargeItemDefinition _implicitRules Extensions for implicitRules Element
ChargeItemDefinition language The base language in which the resource is written. code
ChargeItemDefinition _language Extensions for language Element
ChargeItemDefinition text 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. Narrative
ChargeItemDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ChargeItemDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ChargeItemDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ChargeItemDefinition url 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 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. uri
ChargeItemDefinition _url Extensions for url Element
ChargeItemDefinition identifier 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. Identifier
ChargeItemDefinition version 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. string
ChargeItemDefinition _version Extensions for version Element
ChargeItemDefinition title A short, descriptive, user-friendly title for the charge item definition. string
ChargeItemDefinition _title Extensions for title Element
ChargeItemDefinition derivedFromUri The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition. uri
ChargeItemDefinition _derivedFromUri Extensions for derivedFromUri Element
ChargeItemDefinition partOf A larger definition of which this particular definition is a component or step. canonical
ChargeItemDefinition replaces As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance. canonical
ChargeItemDefinition status The current state of the ChargeItemDefinition. enum values:
draft
active
retired
unknown
ChargeItemDefinition _status Extensions for status Element
ChargeItemDefinition experimental 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. boolean
ChargeItemDefinition _experimental Extensions for experimental Element
ChargeItemDefinition date The date (and optionally time) when the charge item definition 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 charge item definition changes. dateTime
ChargeItemDefinition _date Extensions for date Element
ChargeItemDefinition publisher The name of the organization or individual that published the charge item definition. string
ChargeItemDefinition _publisher Extensions for publisher Element
ChargeItemDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ChargeItemDefinition description A free text natural language description of the charge item definition from a consumer's perspective. markdown
ChargeItemDefinition _description Extensions for description Element
ChargeItemDefinition useContext 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. UsageContext
ChargeItemDefinition jurisdiction A legal or geographic region in which the charge item definition is intended to be used. CodeableConcept
ChargeItemDefinition copyright 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. markdown
ChargeItemDefinition _copyright Extensions for copyright Element
ChargeItemDefinition approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
ChargeItemDefinition _approvalDate Extensions for approvalDate Element
ChargeItemDefinition lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
ChargeItemDefinition _lastReviewDate Extensions for lastReviewDate Element
ChargeItemDefinition effectivePeriod The period during which the charge item definition content was or is planned to be in active use. Period
ChargeItemDefinition code The defined billing details in this resource pertain to the given billing code. CodeableConcept
ChargeItemDefinition instance The defined billing details in this resource pertain to the given product instance(s). Reference
ChargeItemDefinition applicability Expressions that describe applicability criteria for the billing code. ChargeItemDefinition_Applicability
ChargeItemDefinition propertyGroup 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
ChargeItemDefinition_Applicability id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ChargeItemDefinition_Applicability extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ChargeItemDefinition_Applicability modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ChargeItemDefinition_Applicability description A brief, natural language description of the condition that effectively communicates the intended semantics. string
ChargeItemDefinition_Applicability _description Extensions for description Element
ChargeItemDefinition_Applicability language The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions. string
ChargeItemDefinition_Applicability _language Extensions for language Element
ChargeItemDefinition_Applicability expression 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. string
ChargeItemDefinition_Applicability _expression Extensions for expression Element
ChargeItemDefinition_PriceComponent id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ChargeItemDefinition_PriceComponent extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ChargeItemDefinition_PriceComponent modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ChargeItemDefinition_PriceComponent type This code identifies the type of the component. code
ChargeItemDefinition_PriceComponent _type Extensions for type Element
ChargeItemDefinition_PriceComponent code A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. CodeableConcept
ChargeItemDefinition_PriceComponent factor The factor that has been applied on the base price for calculating this component. decimal
ChargeItemDefinition_PriceComponent _factor Extensions for factor Element
ChargeItemDefinition_PriceComponent amount The amount calculated for this component. Money
ChargeItemDefinition_PropertyGroup id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ChargeItemDefinition_PropertyGroup extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ChargeItemDefinition_PropertyGroup modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ChargeItemDefinition_PropertyGroup applicability Expressions that describe applicability criteria for the priceComponent. ChargeItemDefinition_Applicability
ChargeItemDefinition_PropertyGroup priceComponent 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. ChargeItemDefinition_PriceComponent
ChargeItem_Performer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ChargeItem_Performer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ChargeItem_Performer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ChargeItem_Performer function Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.). CodeableConcept
ChargeItem_Performer actor The device, practitioner, etc. who performed or participated in the service. Reference
Claim resourceType This is a Claim resource Claim
Claim id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Claim meta 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. Meta
Claim implicitRules 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. uri
Claim _implicitRules Extensions for implicitRules Element
Claim language The base language in which the resource is written. code
Claim _language Extensions for language Element
Claim text 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. Narrative
Claim contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Claim extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim identifier A unique identifier assigned to this claim. Identifier
Claim status The status of the resource instance. code
Claim _status Extensions for status Element
Claim type The category of claim, e.g. oral, pharmacy, vision, institutional, professional. CodeableConcept
Claim subType A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. CodeableConcept
Claim use A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. enum values:
claim
preauthorization
predetermination
Claim _use Extensions for use Element
Claim patient 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. Reference
Claim billablePeriod The period for which charges are being submitted. Period
Claim created The date this resource was created. dateTime
Claim _created Extensions for created Element
Claim enterer Individual who created the claim, predetermination or preauthorization. Reference
Claim insurer The Insurer who is target of the request. Reference
Claim provider The provider which is responsible for the claim, predetermination or preauthorization. Reference
Claim priority The provider-required urgency of processing the request. Typical values include: stat, routine deferred. CodeableConcept
Claim fundsReserve A code to indicate whether and for whom funds are to be reserved for future claims. CodeableConcept
Claim related Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. Claim_Related
Claim prescription Prescription to support the dispensing of pharmacy, device or vision products. Reference
Claim originalPrescription Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. Reference
Claim payee The party to be reimbursed for cost of the products and services according to the terms of the policy. Claim_Payee
Claim referral A reference to a referral resource. Reference
Claim facility Facility where the services were provided. Reference
Claim careTeam The members of the team who provided the products and services. Claim_CareTeam
Claim supportingInfo Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Claim_SupportingInfo
Claim diagnosis Information about diagnoses relevant to the claim items. Claim_Diagnosis
Claim procedure Procedures performed on the patient relevant to the billing items with the claim. Claim_Procedure
Claim insurance Financial instruments for reimbursement for the health care products and services specified on the claim. Claim_Insurance
Claim accident Details of an accident which resulted in injuries which required the products and services listed in the claim. Claim_Accident
Claim item 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
Claim total The total value of the all the items in the claim. Money
ClaimResponse resourceType This is a ClaimResponse resource ClaimResponse
ClaimResponse id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ClaimResponse meta 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. Meta
ClaimResponse implicitRules 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. uri
ClaimResponse _implicitRules Extensions for implicitRules Element
ClaimResponse language The base language in which the resource is written. code
ClaimResponse _language Extensions for language Element
ClaimResponse text 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. Narrative
ClaimResponse contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ClaimResponse extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse identifier A unique identifier assigned to this claim response. Identifier
ClaimResponse status The status of the resource instance. code
ClaimResponse _status Extensions for status Element
ClaimResponse type A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. CodeableConcept
ClaimResponse subType A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. CodeableConcept
ClaimResponse use A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. code
ClaimResponse _use Extensions for use Element
ClaimResponse patient 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. Reference
ClaimResponse created The date this resource was created. dateTime
ClaimResponse _created Extensions for created Element
ClaimResponse insurer The party responsible for authorization, adjudication and reimbursement. Reference
ClaimResponse requestor The provider which is responsible for the claim, predetermination or preauthorization. Reference
ClaimResponse request Original request resource reference. Reference
ClaimResponse outcome The outcome of the claim, predetermination, or preauthorization processing. code
ClaimResponse _outcome Extensions for outcome Element
ClaimResponse disposition A human readable description of the status of the adjudication. string
ClaimResponse _disposition Extensions for disposition Element
ClaimResponse preAuthRef Reference from the Insurer which is used in later communications which refers to this adjudication. string
ClaimResponse _preAuthRef Extensions for preAuthRef Element
ClaimResponse preAuthPeriod The time frame during which this authorization is effective. Period
ClaimResponse payeeType Type of Party to be reimbursed: subscriber, provider, other. CodeableConcept
ClaimResponse item 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
ClaimResponse addItem The first-tier service adjudications for payor added product or service lines. ClaimResponse_AddItem
ClaimResponse adjudication The adjudication results which are presented at the header level rather than at the line-item or add-item levels. ClaimResponse_Adjudication
ClaimResponse total Categorized monetary totals for the adjudication. ClaimResponse_Total
ClaimResponse payment Payment details for the adjudication of the claim. ClaimResponse_Payment
ClaimResponse fundsReserve A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. CodeableConcept
ClaimResponse formCode A code for the form to be used for printing the content. CodeableConcept
ClaimResponse form The actual form, by reference or inclusion, for printing the content or an EOB. Attachment
ClaimResponse processNote A note that describes or explains adjudication results in a human readable form. ClaimResponse_ProcessNote
ClaimResponse communicationRequest Request for additional supporting or authorizing information. Reference
ClaimResponse insurance Financial instruments for reimbursement for the health care products and services specified on the claim. ClaimResponse_Insurance
ClaimResponse error Errors encountered during the processing of the adjudication. ClaimResponse_Error
ClaimResponse_AddItem id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_AddItem extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_AddItem modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_AddItem itemSequence Claim items which this service line is intended to replace. positiveInt
ClaimResponse_AddItem _itemSequence Extensions for itemSequence Element
ClaimResponse_AddItem detailSequence The sequence number of the details within the claim item which this line is intended to replace. positiveInt
ClaimResponse_AddItem _detailSequence Extensions for detailSequence Element
ClaimResponse_AddItem subdetailSequence The sequence number of the sub-details within the details within the claim item which this line is intended to replace. positiveInt
ClaimResponse_AddItem _subdetailSequence Extensions for subdetailSequence Element
ClaimResponse_AddItem provider The providers who are authorized for the services rendered to the patient. Reference
ClaimResponse_AddItem productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ClaimResponse_AddItem modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ClaimResponse_AddItem programCode Identifies the program under which this may be recovered. CodeableConcept
ClaimResponse_AddItem servicedDate The date or dates when the service or product was supplied, performed or completed. notDefined
ClaimResponse_AddItem _servicedDate Extensions for servicedDate Element
ClaimResponse_AddItem servicedPeriod The date or dates when the service or product was supplied, performed or completed. Period
ClaimResponse_AddItem locationCodeableConcept Where the product or service was provided. CodeableConcept
ClaimResponse_AddItem locationAddress Where the product or service was provided. Address
ClaimResponse_AddItem locationReference Where the product or service was provided. Reference
ClaimResponse_AddItem quantity The number of repetitions of a service or product. Quantity
ClaimResponse_AddItem unitPrice 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. Money
ClaimResponse_AddItem factor 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. decimal
ClaimResponse_AddItem _factor Extensions for factor Element
ClaimResponse_AddItem net The quantity times the unit price for an additional service or product or charge. Money
ClaimResponse_AddItem bodySite Physical service site on the patient (limb, tooth, etc.). CodeableConcept
ClaimResponse_AddItem subSite A region or surface of the bodySite, e.g. limb region or tooth surface(s). CodeableConcept
ClaimResponse_AddItem noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ClaimResponse_AddItem _noteNumber Extensions for noteNumber Element
ClaimResponse_AddItem adjudication The adjudication results. ClaimResponse_Adjudication
ClaimResponse_AddItem detail The second-tier service adjudications for payor added services. ClaimResponse_Detail1
ClaimResponse_Adjudication id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Adjudication extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Adjudication modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Adjudication category 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. CodeableConcept
ClaimResponse_Adjudication reason A code supporting the understanding of the adjudication result and explaining variance from expected amount. CodeableConcept
ClaimResponse_Adjudication amount Monetary amount associated with the category. Money
ClaimResponse_Adjudication value A non-monetary value associated with the category. Mutually exclusive to the amount element above. decimal
ClaimResponse_Adjudication _value Extensions for value Element
ClaimResponse_Detail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Detail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Detail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Detail detailSequence A number to uniquely reference the claim detail entry. positiveInt
ClaimResponse_Detail _detailSequence Extensions for detailSequence Element
ClaimResponse_Detail noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ClaimResponse_Detail _noteNumber Extensions for noteNumber Element
ClaimResponse_Detail adjudication The adjudication results. ClaimResponse_Adjudication
ClaimResponse_Detail subDetail A sub-detail adjudication of a simple product or service. ClaimResponse_SubDetail
ClaimResponse_Detail1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Detail1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Detail1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Detail1 productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ClaimResponse_Detail1 modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ClaimResponse_Detail1 quantity The number of repetitions of a service or product. Quantity
ClaimResponse_Detail1 unitPrice 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. Money
ClaimResponse_Detail1 factor 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. decimal
ClaimResponse_Detail1 _factor Extensions for factor Element
ClaimResponse_Detail1 net The quantity times the unit price for an additional service or product or charge. Money
ClaimResponse_Detail1 noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ClaimResponse_Detail1 _noteNumber Extensions for noteNumber Element
ClaimResponse_Detail1 adjudication The adjudication results. ClaimResponse_Adjudication
ClaimResponse_Detail1 subDetail The third-tier service adjudications for payor added services. ClaimResponse_SubDetail1
ClaimResponse_Error id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Error extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Error modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Error itemSequence 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. positiveInt
ClaimResponse_Error _itemSequence Extensions for itemSequence Element
ClaimResponse_Error detailSequence 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. positiveInt
ClaimResponse_Error _detailSequence Extensions for detailSequence Element
ClaimResponse_Error subDetailSequence 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. positiveInt
ClaimResponse_Error _subDetailSequence Extensions for subDetailSequence Element
ClaimResponse_Error code An error code, from a specified code system, which details why the claim could not be adjudicated. CodeableConcept
ClaimResponse_Insurance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Insurance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Insurance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Insurance sequence A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. positiveInt
ClaimResponse_Insurance _sequence Extensions for sequence Element
ClaimResponse_Insurance focal A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. boolean
ClaimResponse_Insurance _focal Extensions for focal Element
ClaimResponse_Insurance coverage 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. Reference
ClaimResponse_Insurance businessArrangement A business agreement number established between the provider and the insurer for special business processing purposes. string
ClaimResponse_Insurance _businessArrangement Extensions for businessArrangement Element
ClaimResponse_Insurance claimResponse The result of the adjudication of the line items for the Coverage specified in this insurance. Reference
ClaimResponse_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Item itemSequence A number to uniquely reference the claim item entries. positiveInt
ClaimResponse_Item _itemSequence Extensions for itemSequence Element
ClaimResponse_Item noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ClaimResponse_Item _noteNumber Extensions for noteNumber Element
ClaimResponse_Item adjudication 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_Adjudication
ClaimResponse_Item detail A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items. ClaimResponse_Detail
ClaimResponse_Payment id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Payment extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Payment modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Payment type Whether this represents partial or complete payment of the benefits payable. CodeableConcept
ClaimResponse_Payment adjustment Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication. Money
ClaimResponse_Payment adjustmentReason Reason for the payment adjustment. CodeableConcept
ClaimResponse_Payment date Estimated date the payment will be issued or the actual issue date of payment. date
ClaimResponse_Payment _date Extensions for date Element
ClaimResponse_Payment amount Benefits payable less any payment adjustment. Money
ClaimResponse_Payment identifier Issuer's unique identifier for the payment instrument. Identifier
ClaimResponse_ProcessNote id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_ProcessNote extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_ProcessNote modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_ProcessNote number A number to uniquely identify a note entry. positiveInt
ClaimResponse_ProcessNote _number Extensions for number Element
ClaimResponse_ProcessNote type The business purpose of the note text. enum values:
display
print
printoper
ClaimResponse_ProcessNote _type Extensions for type Element
ClaimResponse_ProcessNote text The explanation or description associated with the processing. string
ClaimResponse_ProcessNote _text Extensions for text Element
ClaimResponse_ProcessNote language A code to define the language used in the text of the note. CodeableConcept
ClaimResponse_SubDetail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_SubDetail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_SubDetail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_SubDetail subDetailSequence A number to uniquely reference the claim sub-detail entry. positiveInt
ClaimResponse_SubDetail _subDetailSequence Extensions for subDetailSequence Element
ClaimResponse_SubDetail noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ClaimResponse_SubDetail _noteNumber Extensions for noteNumber Element
ClaimResponse_SubDetail adjudication The adjudication results. ClaimResponse_Adjudication
ClaimResponse_SubDetail1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_SubDetail1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_SubDetail1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_SubDetail1 productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ClaimResponse_SubDetail1 modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ClaimResponse_SubDetail1 quantity The number of repetitions of a service or product. Quantity
ClaimResponse_SubDetail1 unitPrice 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. Money
ClaimResponse_SubDetail1 factor 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. decimal
ClaimResponse_SubDetail1 _factor Extensions for factor Element
ClaimResponse_SubDetail1 net The quantity times the unit price for an additional service or product or charge. Money
ClaimResponse_SubDetail1 noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ClaimResponse_SubDetail1 _noteNumber Extensions for noteNumber Element
ClaimResponse_SubDetail1 adjudication The adjudication results. ClaimResponse_Adjudication
ClaimResponse_Total id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClaimResponse_Total extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClaimResponse_Total modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClaimResponse_Total category 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. CodeableConcept
ClaimResponse_Total amount Monetary total amount associated with the category. Money
Claim_Accident id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Accident extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Accident modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Accident date Date of an accident event related to the products and services contained in the claim. date
Claim_Accident _date Extensions for date Element
Claim_Accident type The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. CodeableConcept
Claim_Accident locationAddress The physical location of the accident event. Address
Claim_Accident locationReference The physical location of the accident event. Reference
Claim_CareTeam id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_CareTeam extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_CareTeam modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_CareTeam sequence A number to uniquely identify care team entries. positiveInt
Claim_CareTeam _sequence Extensions for sequence Element
Claim_CareTeam provider Member of the team who provided the product or service. Reference
Claim_CareTeam responsible The party who is billing and/or responsible for the claimed products or services. boolean
Claim_CareTeam _responsible Extensions for responsible Element
Claim_CareTeam role The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. CodeableConcept
Claim_CareTeam qualification The qualification of the practitioner which is applicable for this service. CodeableConcept
Claim_Detail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Detail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Detail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Detail sequence A number to uniquely identify item entries. positiveInt
Claim_Detail _sequence Extensions for sequence Element
Claim_Detail revenue The type of revenue or cost center providing the product and/or service. CodeableConcept
Claim_Detail category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
Claim_Detail productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
Claim_Detail modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
Claim_Detail programCode Identifies the program under which this may be recovered. CodeableConcept
Claim_Detail quantity The number of repetitions of a service or product. Quantity
Claim_Detail unitPrice 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. Money
Claim_Detail factor 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. decimal
Claim_Detail _factor Extensions for factor Element
Claim_Detail net The quantity times the unit price for an additional service or product or charge. Money
Claim_Detail udi Unique Device Identifiers associated with this line item. Reference
Claim_Detail subDetail A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. Claim_SubDetail
Claim_Diagnosis id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Diagnosis extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Diagnosis modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Diagnosis sequence A number to uniquely identify diagnosis entries. positiveInt
Claim_Diagnosis _sequence Extensions for sequence Element
Claim_Diagnosis diagnosisCodeableConcept The nature of illness or problem in a coded form or as a reference to an external defined Condition. CodeableConcept
Claim_Diagnosis diagnosisReference The nature of illness or problem in a coded form or as a reference to an external defined Condition. Reference
Claim_Diagnosis type When the condition was observed or the relative ranking. CodeableConcept
Claim_Diagnosis onAdmission Indication of whether the diagnosis was present on admission to a facility. CodeableConcept
Claim_Diagnosis packageCode 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. CodeableConcept
Claim_Insurance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Insurance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Insurance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Insurance sequence A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order. positiveInt
Claim_Insurance _sequence Extensions for sequence Element
Claim_Insurance focal A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. boolean
Claim_Insurance _focal Extensions for focal Element
Claim_Insurance identifier The business identifier to be used when the claim is sent for adjudication against this insurance policy. Identifier
Claim_Insurance coverage 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. Reference
Claim_Insurance businessArrangement A business agreement number established between the provider and the insurer for special business processing purposes. string
Claim_Insurance _businessArrangement Extensions for businessArrangement Element
Claim_Insurance preAuthRef 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. string
Claim_Insurance _preAuthRef Extensions for preAuthRef Element
Claim_Insurance claimResponse The result of the adjudication of the line items for the Coverage specified in this insurance. Reference
Claim_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Item sequence A number to uniquely identify item entries. positiveInt
Claim_Item _sequence Extensions for sequence Element
Claim_Item careTeamSequence CareTeam members related to this service or product. positiveInt
Claim_Item _careTeamSequence Extensions for careTeamSequence Element
Claim_Item diagnosisSequence Diagnosis applicable for this service or product. positiveInt
Claim_Item _diagnosisSequence Extensions for diagnosisSequence Element
Claim_Item procedureSequence Procedures applicable for this service or product. positiveInt
Claim_Item _procedureSequence Extensions for procedureSequence Element
Claim_Item informationSequence Exceptions, special conditions and supporting information applicable for this service or product. positiveInt
Claim_Item _informationSequence Extensions for informationSequence Element
Claim_Item revenue The type of revenue or cost center providing the product and/or service. CodeableConcept
Claim_Item category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
Claim_Item productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
Claim_Item modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
Claim_Item programCode Identifies the program under which this may be recovered. CodeableConcept
Claim_Item servicedDate The date or dates when the service or product was supplied, performed or completed. notDefined
Claim_Item _servicedDate Extensions for servicedDate Element
Claim_Item servicedPeriod The date or dates when the service or product was supplied, performed or completed. Period
Claim_Item locationCodeableConcept Where the product or service was provided. CodeableConcept
Claim_Item locationAddress Where the product or service was provided. Address
Claim_Item locationReference Where the product or service was provided. Reference
Claim_Item quantity The number of repetitions of a service or product. Quantity
Claim_Item unitPrice 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. Money
Claim_Item factor 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. decimal
Claim_Item _factor Extensions for factor Element
Claim_Item net The quantity times the unit price for an additional service or product or charge. Money
Claim_Item udi Unique Device Identifiers associated with this line item. Reference
Claim_Item bodySite Physical service site on the patient (limb, tooth, etc.). CodeableConcept
Claim_Item subSite A region or surface of the bodySite, e.g. limb region or tooth surface(s). CodeableConcept
Claim_Item encounter The Encounters during which this Claim was created or to which the creation of this record is tightly associated. Reference
Claim_Item detail A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. Claim_Detail
Claim_Payee id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Payee extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Payee modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Payee type Type of Party to be reimbursed: subscriber, provider, other. CodeableConcept
Claim_Payee party Reference to the individual or organization to whom any payment will be made. Reference
Claim_Procedure id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Procedure extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Procedure modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Procedure sequence A number to uniquely identify procedure entries. positiveInt
Claim_Procedure _sequence Extensions for sequence Element
Claim_Procedure type When the condition was observed or the relative ranking. CodeableConcept
Claim_Procedure date Date and optionally time the procedure was performed. dateTime
Claim_Procedure _date Extensions for date Element
Claim_Procedure procedureCodeableConcept The code or reference to a Procedure resource which identifies the clinical intervention performed. CodeableConcept
Claim_Procedure procedureReference The code or reference to a Procedure resource which identifies the clinical intervention performed. Reference
Claim_Procedure udi Unique Device Identifiers associated with this line item. Reference
Claim_Related id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_Related extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_Related modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_Related claim Reference to a related claim. Reference
Claim_Related relationship A code to convey how the claims are related. CodeableConcept
Claim_Related reference An alternate organizational reference to the case or file to which this particular claim pertains. Identifier
Claim_SubDetail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_SubDetail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_SubDetail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_SubDetail sequence A number to uniquely identify item entries. positiveInt
Claim_SubDetail _sequence Extensions for sequence Element
Claim_SubDetail revenue The type of revenue or cost center providing the product and/or service. CodeableConcept
Claim_SubDetail category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
Claim_SubDetail productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
Claim_SubDetail modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
Claim_SubDetail programCode Identifies the program under which this may be recovered. CodeableConcept
Claim_SubDetail quantity The number of repetitions of a service or product. Quantity
Claim_SubDetail unitPrice 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. Money
Claim_SubDetail factor 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. decimal
Claim_SubDetail _factor Extensions for factor Element
Claim_SubDetail net The quantity times the unit price for an additional service or product or charge. Money
Claim_SubDetail udi Unique Device Identifiers associated with this line item. Reference
Claim_SupportingInfo id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Claim_SupportingInfo extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Claim_SupportingInfo modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Claim_SupportingInfo sequence A number to uniquely identify supporting information entries. positiveInt
Claim_SupportingInfo _sequence Extensions for sequence Element
Claim_SupportingInfo category The general class of the information supplied: information; exception; accident, employment; onset, etc. CodeableConcept
Claim_SupportingInfo code System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. CodeableConcept
Claim_SupportingInfo timingDate The date when or period to which this information refers. notDefined
Claim_SupportingInfo _timingDate Extensions for timingDate Element
Claim_SupportingInfo timingPeriod The date when or period to which this information refers. Period
Claim_SupportingInfo valueBoolean Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. notDefined
Claim_SupportingInfo _valueBoolean Extensions for valueBoolean Element
Claim_SupportingInfo valueString Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. notDefined
Claim_SupportingInfo _valueString Extensions for valueString Element
Claim_SupportingInfo valueQuantity Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Quantity
Claim_SupportingInfo valueAttachment Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Attachment
Claim_SupportingInfo valueReference Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Reference
Claim_SupportingInfo reason Provides the reason in the situation where a reason code is required in addition to the content. CodeableConcept
ClinicalImpression resourceType This is a ClinicalImpression resource ClinicalImpression
ClinicalImpression id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ClinicalImpression meta 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. Meta
ClinicalImpression implicitRules 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. uri
ClinicalImpression _implicitRules Extensions for implicitRules Element
ClinicalImpression language The base language in which the resource is written. code
ClinicalImpression _language Extensions for language Element
ClinicalImpression text 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. Narrative
ClinicalImpression contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ClinicalImpression extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClinicalImpression modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClinicalImpression identifier 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. Identifier
ClinicalImpression status Identifies the workflow status of the assessment. code
ClinicalImpression _status Extensions for status Element
ClinicalImpression statusReason Captures the reason for the current state of the ClinicalImpression. CodeableConcept
ClinicalImpression code Categorizes the type of clinical assessment performed. CodeableConcept
ClinicalImpression description A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it. string
ClinicalImpression _description Extensions for description Element
ClinicalImpression subject The patient or group of individuals assessed as part of this record. Reference
ClinicalImpression encounter The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated. Reference
ClinicalImpression effectiveDateTime The point in time or period over which the subject was assessed. notDefined
ClinicalImpression _effectiveDateTime Extensions for effectiveDateTime Element
ClinicalImpression effectivePeriod The point in time or period over which the subject was assessed. Period
ClinicalImpression date Indicates when the documentation of the assessment was complete. dateTime
ClinicalImpression _date Extensions for date Element
ClinicalImpression assessor The clinician performing the assessment. Reference
ClinicalImpression previous 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. Reference
ClinicalImpression problem A list of the relevant problems/conditions for a patient. Reference
ClinicalImpression investigation One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes. ClinicalImpression_Investigation
ClinicalImpression protocol Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis. uri
ClinicalImpression _protocol Extensions for protocol Element
ClinicalImpression summary A text summary of the investigations and the diagnosis. string
ClinicalImpression _summary Extensions for summary Element
ClinicalImpression finding Specific findings or diagnoses that were considered likely or relevant to ongoing treatment. ClinicalImpression_Finding
ClinicalImpression prognosisCodeableConcept Estimate of likely outcome. CodeableConcept
ClinicalImpression prognosisReference RiskAssessment expressing likely outcome. Reference
ClinicalImpression supportingInfo Information supporting the clinical impression. Reference
ClinicalImpression note Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear. Annotation
ClinicalImpression_Finding id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClinicalImpression_Finding extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClinicalImpression_Finding modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClinicalImpression_Finding itemCodeableConcept Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions. CodeableConcept
ClinicalImpression_Finding itemReference Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions. Reference
ClinicalImpression_Finding basis Which investigations support finding or diagnosis. string
ClinicalImpression_Finding _basis Extensions for basis Element
ClinicalImpression_Investigation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ClinicalImpression_Investigation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ClinicalImpression_Investigation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ClinicalImpression_Investigation code A name/code for the group ("set") of investigations. Typically, this will be something like "signs", "symptoms", "clinical", "diagnostic", but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used. CodeableConcept
ClinicalImpression_Investigation item A record of a specific investigation that was undertaken. Reference
CodeSystem resourceType This is a CodeSystem resource CodeSystem
CodeSystem id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CodeSystem meta 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. Meta
CodeSystem implicitRules 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. uri
CodeSystem _implicitRules Extensions for implicitRules Element
CodeSystem language The base language in which the resource is written. code
CodeSystem _language Extensions for language Element
CodeSystem text 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. Narrative
CodeSystem contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CodeSystem extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CodeSystem modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CodeSystem url 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 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. uri
CodeSystem _url Extensions for url Element
CodeSystem identifier 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. Identifier
CodeSystem version 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. string
CodeSystem _version Extensions for version Element
CodeSystem name 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. string
CodeSystem _name Extensions for name Element
CodeSystem title A short, descriptive, user-friendly title for the code system. string
CodeSystem _title Extensions for title Element
CodeSystem status The date (and optionally time) when the code system resource was created or revised. enum values:
draft
active
retired
unknown
CodeSystem _status Extensions for status Element
CodeSystem experimental 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. boolean
CodeSystem _experimental Extensions for experimental Element
CodeSystem date The date (and optionally time) when the code system 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 code system changes. dateTime
CodeSystem _date Extensions for date Element
CodeSystem publisher The name of the organization or individual that published the code system. string
CodeSystem _publisher Extensions for publisher Element
CodeSystem contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
CodeSystem description A free text natural language description of the code system from a consumer's perspective. markdown
CodeSystem _description Extensions for description Element
CodeSystem useContext 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. UsageContext
CodeSystem jurisdiction A legal or geographic region in which the code system is intended to be used. CodeableConcept
CodeSystem purpose Explanation of why this code system is needed and why it has been designed as it has. markdown
CodeSystem _purpose Extensions for purpose Element
CodeSystem copyright 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. markdown
CodeSystem _copyright Extensions for copyright Element
CodeSystem caseSensitive If code comparison is case sensitive when codes within this system are compared to each other. boolean
CodeSystem _caseSensitive Extensions for caseSensitive Element
CodeSystem valueSet Canonical reference to the value set that contains the entire code system. canonical
CodeSystem hierarchyMeaning The meaning of the hierarchy of concepts as represented in this resource. enum values:
grouped-by
is-a
part-of
classified-with
CodeSystem _hierarchyMeaning Extensions for hierarchyMeaning Element
CodeSystem compositional The code system defines a compositional (post-coordination) grammar. boolean
CodeSystem _compositional Extensions for compositional Element
CodeSystem versionNeeded 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. boolean
CodeSystem _versionNeeded Extensions for versionNeeded Element
CodeSystem content The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. enum values:
not-present
example
fragment
complete
supplement
CodeSystem _content Extensions for content Element
CodeSystem supplements The canonical URL of the code system that this code system supplement is adding designations and properties to. canonical
CodeSystem count 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. unsignedInt
CodeSystem _count Extensions for count Element
CodeSystem filter A filter that can be used in a value set compose statement when selecting concepts using a filter. CodeSystem_Filter
CodeSystem property A property defines an additional slot through which additional information can be provided about a concept. CodeSystem_Property
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. CodeSystem_Concept
CodeSystem_Concept id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CodeSystem_Concept extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CodeSystem_Concept modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CodeSystem_Concept code A code - a text symbol - that uniquely identifies the concept within the code system. code
CodeSystem_Concept _code Extensions for code Element
CodeSystem_Concept display A human readable string that is the recommended default way to present this concept to a user. string
CodeSystem_Concept _display Extensions for display Element
CodeSystem_Concept definition 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. string
CodeSystem_Concept _definition Extensions for definition Element
CodeSystem_Concept designation Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. CodeSystem_Designation
CodeSystem_Concept property A property value for this concept. CodeSystem_Property1
CodeSystem_Concept concept Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning. CodeSystem_Concept
CodeSystem_Designation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CodeSystem_Designation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CodeSystem_Designation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CodeSystem_Designation language The language this designation is defined for. code
CodeSystem_Designation _language Extensions for language Element
CodeSystem_Designation use A code that details how this designation would be used. Coding
CodeSystem_Designation value The text value for this designation. string
CodeSystem_Designation _value Extensions for value Element
CodeSystem_Filter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CodeSystem_Filter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CodeSystem_Filter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CodeSystem_Filter code The code that identifies this filter when it is used as a filter in [[[ValueSet]]].compose.include.filter. code
CodeSystem_Filter _code Extensions for code Element
CodeSystem_Filter description A description of how or why the filter is used. string
CodeSystem_Filter _description Extensions for description Element
CodeSystem_Filter operator A list of operators that can be used with the filter. code
CodeSystem_Filter _operator Extensions for operator Element
CodeSystem_Filter value A description of what the value for the filter should be. string
CodeSystem_Filter _value Extensions for value Element
CodeSystem_Property id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CodeSystem_Property extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CodeSystem_Property modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CodeSystem_Property code 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. code
CodeSystem_Property _code Extensions for code Element
CodeSystem_Property uri Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system. uri
CodeSystem_Property _uri Extensions for uri Element
CodeSystem_Property description A description of the property- why it is defined, and how its value might be used. string
CodeSystem_Property _description Extensions for description Element
CodeSystem_Property type 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). enum values:
code
Coding
string
integer
boolean
dateTime
decimal
CodeSystem_Property _type Extensions for type Element
CodeSystem_Property1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CodeSystem_Property1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CodeSystem_Property1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CodeSystem_Property1 code A code that is a reference to CodeSystem.property.code. code
CodeSystem_Property1 _code Extensions for code Element
CodeSystem_Property1 valueCode The value of this property. notDefined
CodeSystem_Property1 _valueCode Extensions for valueCode Element
CodeSystem_Property1 valueCoding The value of this property. Coding
CodeSystem_Property1 valueString The value of this property. notDefined
CodeSystem_Property1 _valueString Extensions for valueString Element
CodeSystem_Property1 valueInteger The value of this property. notDefined
CodeSystem_Property1 _valueInteger Extensions for valueInteger Element
CodeSystem_Property1 valueBoolean The value of this property. notDefined
CodeSystem_Property1 _valueBoolean Extensions for valueBoolean Element
CodeSystem_Property1 valueDateTime The value of this property. notDefined
CodeSystem_Property1 _valueDateTime Extensions for valueDateTime Element
CodeSystem_Property1 valueDecimal The value of this property. notDefined
CodeSystem_Property1 _valueDecimal Extensions for valueDecimal Element
CodeableConcept id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CodeableConcept extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CodeableConcept coding A reference to a code defined by a terminology system. Coding
CodeableConcept text 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. string
CodeableConcept _text Extensions for text Element
Coding id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Coding extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Coding system The identification of the code system that defines the meaning of the symbol in the code. uri
Coding _system Extensions for system Element
Coding version 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. string
Coding _version Extensions for version Element
Coding code 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). code
Coding _code Extensions for code Element
Coding display A representation of the meaning of the code in the system, following the rules of the system. string
Coding _display Extensions for display Element
Coding userSelected Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). boolean
Coding _userSelected Extensions for userSelected Element
Communication resourceType This is a Communication resource Communication
Communication id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Communication meta 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. Meta
Communication implicitRules 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. uri
Communication _implicitRules Extensions for implicitRules Element
Communication language The base language in which the resource is written. code
Communication _language Extensions for language Element
Communication text 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. Narrative
Communication contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Communication extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Communication modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Communication identifier 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. Identifier
Communication instantiatesCanonical 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. canonical
Communication instantiatesUri 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. uri
Communication _instantiatesUri Extensions for instantiatesUri Element
Communication basedOn An order, proposal or plan fulfilled in whole or in part by this Communication. Reference
Communication partOf Part of this action. Reference
Communication inResponseTo Prior communication that this communication is in response to. Reference
Communication status The status of the transmission. code
Communication _status Extensions for status Element
Communication statusReason Captures the reason for the current state of the Communication. CodeableConcept
Communication category The type of message conveyed such as alert, notification, reminder, instruction, etc. CodeableConcept
Communication priority Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. code
Communication _priority Extensions for priority Element
Communication medium A channel that was used for this communication (e.g. email, fax). CodeableConcept
Communication subject The patient or group that was the focus of this communication. Reference
Communication topic Description of the purpose/content, similar to a subject line in an email. CodeableConcept
Communication about Other resources that pertain to this communication and to which this communication should be associated. Reference
Communication encounter The Encounter during which this Communication was created or to which the creation of this record is tightly associated. Reference
Communication sent The time when this communication was sent. dateTime
Communication _sent Extensions for sent Element
Communication received The time when this communication arrived at the destination. dateTime
Communication _received Extensions for received Element
Communication recipient The entity (e.g. person, organization, clinical information system, care team or device) which was 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). Reference
Communication sender The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Reference
Communication reasonCode The reason or justification for the communication. CodeableConcept
Communication reasonReference Indicates another resource whose existence justifies this communication. Reference
Communication payload Text, attachment(s), or resource(s) that was communicated to the recipient. Communication_Payload
Communication note Additional notes or commentary about the communication by the sender, receiver or other interested parties. Annotation
CommunicationRequest resourceType This is a CommunicationRequest resource CommunicationRequest
CommunicationRequest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CommunicationRequest meta 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. Meta
CommunicationRequest implicitRules 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. uri
CommunicationRequest _implicitRules Extensions for implicitRules Element
CommunicationRequest language The base language in which the resource is written. code
CommunicationRequest _language Extensions for language Element
CommunicationRequest text 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. Narrative
CommunicationRequest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CommunicationRequest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CommunicationRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CommunicationRequest identifier 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. Identifier
CommunicationRequest basedOn A plan or proposal that is fulfilled in whole or in part by this request. Reference
CommunicationRequest replaces Completed or terminated request(s) whose function is taken by this new request. Reference
CommunicationRequest groupIdentifier A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. Identifier
CommunicationRequest status The status of the proposal or order. code
CommunicationRequest _status Extensions for status Element
CommunicationRequest statusReason Captures the reason for the current state of the CommunicationRequest. CodeableConcept
CommunicationRequest category The type of message to be sent such as alert, notification, reminder, instruction, etc. CodeableConcept
CommunicationRequest priority Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. code
CommunicationRequest _priority Extensions for priority Element
CommunicationRequest doNotPerform If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. boolean
CommunicationRequest _doNotPerform Extensions for doNotPerform Element
CommunicationRequest medium A channel that was used for this communication (e.g. email, fax). CodeableConcept
CommunicationRequest subject The patient or group that is the focus of this communication request. Reference
CommunicationRequest about Other resources that pertain to this communication request and to which this communication request should be associated. Reference
CommunicationRequest encounter The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. Reference
CommunicationRequest payload Text, attachment(s), or resource(s) to be communicated to the recipient. CommunicationRequest_Payload
CommunicationRequest occurrenceDateTime The time when this communication is to occur. notDefined
CommunicationRequest _occurrenceDateTime Extensions for occurrenceDateTime Element
CommunicationRequest occurrencePeriod The time when this communication is to occur. Period
CommunicationRequest authoredOn For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. dateTime
CommunicationRequest _authoredOn Extensions for authoredOn Element
CommunicationRequest requester The device, individual, or organization who initiated the request and has responsibility for its activation. Reference
CommunicationRequest recipient The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. Reference
CommunicationRequest sender The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. Reference
CommunicationRequest reasonCode Describes why the request is being made in coded or textual form. CodeableConcept
CommunicationRequest reasonReference Indicates another resource whose existence justifies this request. Reference
CommunicationRequest note Comments made about the request by the requester, sender, recipient, subject or other participants. Annotation
CommunicationRequest_Payload id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CommunicationRequest_Payload extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CommunicationRequest_Payload modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CommunicationRequest_Payload contentString The communicated content (or for multi-part communications, one portion of the communication). notDefined
CommunicationRequest_Payload _contentString Extensions for contentString Element
CommunicationRequest_Payload contentAttachment The communicated content (or for multi-part communications, one portion of the communication). Attachment
CommunicationRequest_Payload contentReference The communicated content (or for multi-part communications, one portion of the communication). Reference
Communication_Payload id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Communication_Payload extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Communication_Payload modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Communication_Payload contentString A communicated content (or for multi-part communications, one portion of the communication). notDefined
Communication_Payload _contentString Extensions for contentString Element
Communication_Payload contentAttachment A communicated content (or for multi-part communications, one portion of the communication). Attachment
Communication_Payload contentReference A communicated content (or for multi-part communications, one portion of the communication). Reference
CompartmentDefinition resourceType This is a CompartmentDefinition resource CompartmentDefinition
CompartmentDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CompartmentDefinition meta 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. Meta
CompartmentDefinition implicitRules 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. uri
CompartmentDefinition _implicitRules Extensions for implicitRules Element
CompartmentDefinition language The base language in which the resource is written. code
CompartmentDefinition _language Extensions for language Element
CompartmentDefinition text 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. Narrative
CompartmentDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CompartmentDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CompartmentDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CompartmentDefinition url 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 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. uri
CompartmentDefinition _url Extensions for url Element
CompartmentDefinition version 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. string
CompartmentDefinition _version Extensions for version Element
CompartmentDefinition name 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. string
CompartmentDefinition _name Extensions for name Element
CompartmentDefinition status The status of this compartment definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
CompartmentDefinition _status Extensions for status Element
CompartmentDefinition experimental 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. boolean
CompartmentDefinition _experimental Extensions for experimental Element
CompartmentDefinition date The date (and optionally time) when the compartment definition 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 compartment definition changes. dateTime
CompartmentDefinition _date Extensions for date Element
CompartmentDefinition publisher The name of the organization or individual that published the compartment definition. string
CompartmentDefinition _publisher Extensions for publisher Element
CompartmentDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
CompartmentDefinition description A free text natural language description of the compartment definition from a consumer's perspective. markdown
CompartmentDefinition _description Extensions for description Element
CompartmentDefinition useContext 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. UsageContext
CompartmentDefinition purpose Explanation of why this compartment definition is needed and why it has been designed as it has. markdown
CompartmentDefinition _purpose Extensions for purpose Element
CompartmentDefinition code Which compartment this definition describes. enum values:
Patient
Encounter
RelatedPerson
Practitioner
Device
CompartmentDefinition _code Extensions for code Element
CompartmentDefinition search Whether the search syntax is supported,. boolean
CompartmentDefinition _search Extensions for search Element
CompartmentDefinition resource Information about how a resource is related to the compartment. CompartmentDefinition_Resource
CompartmentDefinition_Resource id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CompartmentDefinition_Resource extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CompartmentDefinition_Resource modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CompartmentDefinition_Resource code The name of a resource supported by the server. code
CompartmentDefinition_Resource _code Extensions for code Element
CompartmentDefinition_Resource param 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,. string
CompartmentDefinition_Resource _param Extensions for param Element
CompartmentDefinition_Resource documentation Additional documentation about the resource and compartment. string
CompartmentDefinition_Resource _documentation Extensions for documentation Element
Composition resourceType This is a Composition resource Composition
Composition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Composition meta 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. Meta
Composition implicitRules 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. uri
Composition _implicitRules Extensions for implicitRules Element
Composition language The base language in which the resource is written. code
Composition _language Extensions for language Element
Composition text 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. Narrative
Composition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Composition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Composition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Composition identifier A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Identifier
Composition status The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. enum values:
preliminary
final
amended
entered-in-error
Composition _status Extensions for status Element
Composition type 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. CodeableConcept
Composition category 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. CodeableConcept
Composition subject 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). Reference
Composition encounter Describes the clinical encounter or type of care this documentation is associated with. Reference
Composition date The composition editing time, when the composition was last logically changed by the author. dateTime
Composition _date Extensions for date Element
Composition author Identifies who is responsible for the information in the composition, not necessarily who typed it in. Reference
Composition title Official human-readable label for the composition. string
Composition _title Extensions for title Element
Composition confidentiality The code specifying the level of confidentiality of the Composition. code
Composition _confidentiality Extensions for confidentiality Element
Composition attester A participant who has attested to the accuracy of the composition/document. Composition_Attester
Composition custodian Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. Reference
Composition relatesTo Relationships that this composition has with other compositions or documents that already exist. Composition_RelatesTo
Composition event The clinical service, such as a colonoscopy or an appendectomy, being documented. Composition_Event
Composition section The root of the sections that make up the composition. Composition_Section
Composition_Attester id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Composition_Attester extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Composition_Attester modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Composition_Attester mode The type of attestation the authenticator offers. enum values:
personal
professional
legal
official
Composition_Attester _mode Extensions for mode Element
Composition_Attester time When the composition was attested by the party. dateTime
Composition_Attester _time Extensions for time Element
Composition_Attester party Who attested the composition in the specified way. Reference
Composition_Event id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Composition_Event extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Composition_Event modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Composition_Event code 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 typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. CodeableConcept
Composition_Event period 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. Period
Composition_Event detail The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy. Reference
Composition_RelatesTo id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Composition_RelatesTo extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Composition_RelatesTo modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Composition_RelatesTo code The type of relationship that this composition has with anther composition or document. code
Composition_RelatesTo _code Extensions for code Element
Composition_RelatesTo targetIdentifier The target composition/document of this relationship. Identifier
Composition_RelatesTo targetReference The target composition/document of this relationship. Reference
Composition_Section id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Composition_Section extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Composition_Section modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Composition_Section title 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. string
Composition_Section _title Extensions for title Element
Composition_Section code A code identifying the kind of content contained within the section. This must be consistent with the section title. CodeableConcept
Composition_Section author Identifies who is responsible for the information in this section, not necessarily who typed it in. Reference
Composition_Section focus 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). Reference
Composition_Section text 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. Narrative
Composition_Section mode 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. code
Composition_Section _mode Extensions for mode Element
Composition_Section orderedBy Specifies the order applied to the items in the section entries. CodeableConcept
Composition_Section entry A reference to the actual resource from which the narrative in the section is derived. Reference
Composition_Section emptyReason If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. CodeableConcept
Composition_Section section A nested sub-section within this section. Composition_Section
ConceptMap resourceType This is a ConceptMap resource ConceptMap
ConceptMap id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ConceptMap meta 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. Meta
ConceptMap implicitRules 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. uri
ConceptMap _implicitRules Extensions for implicitRules Element
ConceptMap language The base language in which the resource is written. code
ConceptMap _language Extensions for language Element
ConceptMap text 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. Narrative
ConceptMap contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ConceptMap extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ConceptMap modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ConceptMap url 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 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. uri
ConceptMap _url Extensions for url Element
ConceptMap identifier 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. Identifier
ConceptMap version 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. string
ConceptMap _version Extensions for version Element
ConceptMap name 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. string
ConceptMap _name Extensions for name Element
ConceptMap title A short, descriptive, user-friendly title for the concept map. string
ConceptMap _title Extensions for title Element
ConceptMap status The status of this concept map. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
ConceptMap _status Extensions for status Element
ConceptMap experimental 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. boolean
ConceptMap _experimental Extensions for experimental Element
ConceptMap date The date (and optionally time) when the concept map 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 concept map changes. dateTime
ConceptMap _date Extensions for date Element
ConceptMap publisher The name of the organization or individual that published the concept map. string
ConceptMap _publisher Extensions for publisher Element
ConceptMap contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ConceptMap description A free text natural language description of the concept map from a consumer's perspective. markdown
ConceptMap _description Extensions for description Element
ConceptMap useContext 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. UsageContext
ConceptMap jurisdiction A legal or geographic region in which the concept map is intended to be used. CodeableConcept
ConceptMap purpose Explanation of why this concept map is needed and why it has been designed as it has. markdown
ConceptMap _purpose Extensions for purpose Element
ConceptMap copyright 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. markdown
ConceptMap _copyright Extensions for copyright Element
ConceptMap sourceUri Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. notDefined
ConceptMap _sourceUri Extensions for sourceUri Element
ConceptMap sourceCanonical Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. notDefined
ConceptMap _sourceCanonical Extensions for sourceCanonical Element
ConceptMap targetUri The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made. notDefined
ConceptMap _targetUri Extensions for targetUri Element
ConceptMap targetCanonical The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made. notDefined
ConceptMap _targetCanonical Extensions for targetCanonical Element
ConceptMap group A group of mappings that all have the same source and target system. ConceptMap_Group
ConceptMap_DependsOn id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ConceptMap_DependsOn extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ConceptMap_DependsOn modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ConceptMap_DependsOn property A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property. uri
ConceptMap_DependsOn _property Extensions for property Element
ConceptMap_DependsOn system An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems). canonical
ConceptMap_DependsOn value Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to. string
ConceptMap_DependsOn _value Extensions for value Element
ConceptMap_DependsOn display The display for the code. The display is only provided to help editors when editing the concept map. string
ConceptMap_DependsOn _display Extensions for display Element
ConceptMap_Element id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ConceptMap_Element extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ConceptMap_Element modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ConceptMap_Element code Identity (code or path) or the element/item being mapped. code
ConceptMap_Element _code Extensions for code Element
ConceptMap_Element display The display for the code. The display is only provided to help editors when editing the concept map. string
ConceptMap_Element _display Extensions for display Element
ConceptMap_Element target A concept from the target value set that this concept maps to. ConceptMap_Target
ConceptMap_Group id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ConceptMap_Group extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ConceptMap_Group modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ConceptMap_Group source An absolute URI that identifies the source system where the concepts to be mapped are defined. uri
ConceptMap_Group _source Extensions for source Element
ConceptMap_Group sourceVersion The specific version of the code system, as determined by the code system authority. string
ConceptMap_Group _sourceVersion Extensions for sourceVersion Element
ConceptMap_Group target An absolute URI that identifies the target system that the concepts will be mapped to. uri
ConceptMap_Group _target Extensions for target Element
ConceptMap_Group targetVersion The specific version of the code system, as determined by the code system authority. string
ConceptMap_Group _targetVersion Extensions for targetVersion Element
ConceptMap_Group element Mappings for an individual concept in the source to one or more concepts in the target. ConceptMap_Element
ConceptMap_Group unmapped What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched. ConceptMap_Unmapped
ConceptMap_Target id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ConceptMap_Target extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ConceptMap_Target modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ConceptMap_Target code Identity (code or path) or the element/item that the map refers to. code
ConceptMap_Target _code Extensions for code Element
ConceptMap_Target display The display for the code. The display is only provided to help editors when editing the concept map. string
ConceptMap_Target _display Extensions for display Element
ConceptMap_Target equivalence The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source). enum values:
relatedto
equivalent
equal
wider
subsumes
narrower
specializes
inexact
unmatched
disjoint
ConceptMap_Target _equivalence Extensions for equivalence Element
ConceptMap_Target comment A description of status/issues in mapping that conveys additional information not represented in the structured data. string
ConceptMap_Target _comment Extensions for comment Element
ConceptMap_Target dependsOn A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value. ConceptMap_DependsOn
ConceptMap_Target product A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on. ConceptMap_DependsOn
ConceptMap_Unmapped id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ConceptMap_Unmapped extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ConceptMap_Unmapped modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ConceptMap_Unmapped mode 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 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). enum values:
provided
fixed
other-map
ConceptMap_Unmapped _mode Extensions for mode Element
ConceptMap_Unmapped code The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code. code
ConceptMap_Unmapped _code Extensions for code Element
ConceptMap_Unmapped display The display for the code. The display is only provided to help editors when editing the concept map. string
ConceptMap_Unmapped _display Extensions for display Element
ConceptMap_Unmapped url 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. canonical
Condition resourceType This is a Condition resource Condition
Condition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Condition meta 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. Meta
Condition implicitRules 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. uri
Condition _implicitRules Extensions for implicitRules Element
Condition language The base language in which the resource is written. code
Condition _language Extensions for language Element
Condition text 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. Narrative
Condition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Condition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Condition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Condition identifier 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. Identifier
Condition clinicalStatus The clinical status of the condition. CodeableConcept
Condition verificationStatus The verification status to support the clinical status of the condition. CodeableConcept
Condition category A category assigned to the condition. CodeableConcept
Condition severity A subjective assessment of the severity of the condition as evaluated by the clinician. CodeableConcept
Condition code Identification of the condition, problem or diagnosis. CodeableConcept
Condition bodySite The anatomical location where this condition manifests itself. CodeableConcept
Condition subject Indicates the patient or group who the condition record is associated with. Reference
Condition encounter The Encounter during which this Condition was created or to which the creation of this record is tightly associated. Reference
Condition onsetDateTime Estimated or actual date or date-time the condition began, in the opinion of the clinician. notDefined
Condition _onsetDateTime Extensions for onsetDateTime Element
Condition onsetAge Estimated or actual date or date-time the condition began, in the opinion of the clinician. Age
Condition onsetPeriod Estimated or actual date or date-time the condition began, in the opinion of the clinician. Period
Condition onsetRange Estimated or actual date or date-time the condition began, in the opinion of the clinician. Range
Condition onsetString Estimated or actual date or date-time the condition began, in the opinion of the clinician. notDefined
Condition _onsetString Extensions for onsetString Element
Condition abatementDateTime 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" - Conditions are never really resolved, but they can abate. notDefined
Condition _abatementDateTime Extensions for abatementDateTime Element
Condition abatementAge 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" - Conditions are never really resolved, but they can abate. Age
Condition abatementPeriod 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" - Conditions are never really resolved, but they can abate. Period
Condition abatementRange 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" - Conditions are never really resolved, but they can abate. Range
Condition abatementString 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" - Conditions are never really resolved, but they can abate. notDefined
Condition _abatementString Extensions for abatementString Element
Condition recordedDate The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. dateTime
Condition _recordedDate Extensions for recordedDate Element
Condition recorder Individual who recorded the record and takes responsibility for its content. Reference
Condition asserter Individual who is making the condition statement. Reference
Condition stage Clinical stage or grade of a condition. May include formal severity assessments. Condition_Stage
Condition evidence Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. Condition_Evidence
Condition note Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. Annotation
Condition_Evidence id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Condition_Evidence extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Condition_Evidence modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Condition_Evidence code A manifestation or symptom that led to the recording of this condition. CodeableConcept
Condition_Evidence detail Links to other relevant information, including pathology reports. Reference
Condition_Stage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Condition_Stage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Condition_Stage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Condition_Stage summary A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific. CodeableConcept
Condition_Stage assessment Reference to a formal record of the evidence on which the staging assessment is based. Reference
Condition_Stage type The kind of staging, such as pathological or clinical staging. CodeableConcept
Consent resourceType This is a Consent resource Consent
Consent id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Consent meta 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. Meta
Consent implicitRules 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. uri
Consent _implicitRules Extensions for implicitRules Element
Consent language The base language in which the resource is written. code
Consent _language Extensions for language Element
Consent text 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. Narrative
Consent contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Consent extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Consent modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Consent identifier Unique identifier for this copy of the Consent Statement. Identifier
Consent status Indicates the current state of this consent. enum values:
draft
proposed
active
rejected
inactive
entered-in-error
Consent _status Extensions for status Element
Consent scope A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. CodeableConcept
Consent category A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. CodeableConcept
Consent patient The patient/healthcare consumer to whom this consent applies. Reference
Consent dateTime When this Consent was issued / created / indexed. dateTime
Consent _dateTime Extensions for dateTime Element
Consent performer Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. Reference
Consent organization The organization that manages the consent, and the framework within which it is executed. Reference
Consent sourceAttachment The source on which this consent statement is based. The source might be a scanned original paper form, or 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. Attachment
Consent sourceReference The source on which this consent statement is based. The source might be a scanned original paper form, or 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. Reference
Consent policy The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. Consent_Policy
Consent policyRule A reference to the specific base computable regulation or policy. CodeableConcept
Consent verification 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
Consent provision An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. Consent_Provision
Consent_Actor id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Consent_Actor extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Consent_Actor modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Consent_Actor role How the individual is involved in the resources content that is described in the exception. CodeableConcept
Consent_Actor reference 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'). Reference
Consent_Data id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Consent_Data extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Consent_Data modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Consent_Data meaning How the resource reference is interpreted when testing consent restrictions. enum values:
instance
related
dependents
authoredby
Consent_Data _meaning Extensions for meaning Element
Consent_Data reference A reference to a specific resource that defines which resources are covered by this consent. Reference
Consent_Policy id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Consent_Policy extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Consent_Policy modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Consent_Policy authority Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. uri
Consent_Policy _authority Extensions for authority Element
Consent_Policy uri The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. uri
Consent_Policy _uri Extensions for uri Element
Consent_Provision id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Consent_Provision extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Consent_Provision modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Consent_Provision type Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. enum values:
deny
permit
Consent_Provision _type Extensions for type Element
Consent_Provision period The timeframe in this rule is valid. Period
Consent_Provision actor Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). Consent_Actor
Consent_Provision action Actions controlled by this Rule. CodeableConcept
Consent_Provision securityLabel A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. Coding
Consent_Provision purpose The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. Coding
Consent_Provision class The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. Coding
Consent_Provision code If this code is found in an instance, then the rule applies. CodeableConcept
Consent_Provision dataPeriod Clinical or Operational Relevant period of time that bounds the data controlled by this rule. Period
Consent_Provision data The resources controlled by this rule if specific resources are referenced. Consent_Data
Consent_Provision provision Rules which provide exceptions to the base rule or subrules. Consent_Provision
Consent_Verification id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Consent_Verification extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Consent_Verification modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Consent_Verification verified Has the instruction been verified. boolean
Consent_Verification _verified Extensions for verified Element
Consent_Verification verifiedWith Who verified the instruction (Patient, Relative or other Authorized Person). Reference
Consent_Verification verificationDate Date verification was collected. dateTime
Consent_Verification _verificationDate Extensions for verificationDate Element
ContactDetail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ContactDetail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ContactDetail name The name of an individual to contact. string
ContactDetail _name Extensions for name Element
ContactDetail telecom The contact details for the individual (if a name was provided) or the organization. ContactPoint
ContactPoint id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ContactPoint extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ContactPoint system Telecommunications form for contact point - what communications system is required to make use of the contact. enum values:
phone
fax
email
pager
url
sms
other
ContactPoint _system Extensions for system Element
ContactPoint value The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). string
ContactPoint _value Extensions for value Element
ContactPoint use Identifies the purpose for the contact point. enum values:
home
work
temp
old
mobile
ContactPoint _use Extensions for use Element
ContactPoint rank 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. positiveInt
ContactPoint _rank Extensions for rank Element
ContactPoint period Time period when the contact point was/is in use. Period
Contract resourceType This is a Contract resource Contract
Contract id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Contract meta 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. Meta
Contract implicitRules 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. uri
Contract _implicitRules Extensions for implicitRules Element
Contract language The base language in which the resource is written. code
Contract _language Extensions for language Element
Contract text 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. Narrative
Contract contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Contract extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract identifier Unique identifier for this Contract or a derivative that references a Source Contract. Identifier
Contract url Canonical identifier for this contract, represented as a URI (globally unique). uri
Contract _url Extensions for url Element
Contract version An edition identifier used for business purposes to label business significant variants. string
Contract _version Extensions for version Element
Contract status The status of the resource instance. code
Contract _status Extensions for status Element
Contract legalState 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. CodeableConcept
Contract instantiatesCanonical The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract. Reference
Contract instantiatesUri The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract. uri
Contract _instantiatesUri Extensions for instantiatesUri Element
Contract contentDerivative The minimal content derived from the basal information source at a specific stage in its lifecycle. CodeableConcept
Contract issued When this Contract was issued. dateTime
Contract _issued Extensions for issued Element
Contract applies Relevant time or time-period when this Contract is applicable. Period
Contract expirationType Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract. CodeableConcept
Contract subject The target entity impacted by or of interest to parties to the agreement. Reference
Contract authority 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. Reference
Contract domain 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. Reference
Contract site Sites in which the contract is complied with, exercised, or in force. Reference
Contract name 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. string
Contract _name Extensions for name Element
Contract title A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. string
Contract _title Extensions for title Element
Contract subtitle An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content. string
Contract _subtitle Extensions for subtitle Element
Contract alias 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. string
Contract _alias Extensions for alias Element
Contract author The individual or organization that authored the Contract definition, derivative, or instance in any legal state. Reference
Contract scope A selector of legal concerns for this Contract definition, derivative, or instance in any legal state. CodeableConcept
Contract topicCodeableConcept Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. CodeableConcept
Contract topicReference Narrows the range of legal concerns to focus on the achievement of specific contractual objectives. Reference
Contract type 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. CodeableConcept
Contract subType 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. CodeableConcept
Contract contentDefinition 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
Contract term One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. Contract_Term
Contract supportingInfo Information that may be needed by/relevant to the performer in their execution of this term action. Reference
Contract relevantHistory 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 Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity. Reference
Contract signer 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. Contract_Signer
Contract friendly 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
Contract legal List of Legal expressions or representations of this Contract. Contract_Legal
Contract rule List of Computable Policy Rule Language Representations of this Contract. Contract_Rule
Contract legallyBindingAttachment 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. Attachment
Contract legallyBindingReference 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. Reference
Contract_Action id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Action extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Action modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Action doNotPerform True if the term prohibits the action. boolean
Contract_Action _doNotPerform Extensions for doNotPerform Element
Contract_Action type Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term. CodeableConcept
Contract_Action subject Entity of the action. Contract_Subject
Contract_Action intent Reason or purpose for the action stipulated by this Contract Provision. CodeableConcept
Contract_Action linkId Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse. string
Contract_Action _linkId Extensions for linkId Element
Contract_Action status Current state of the term action. CodeableConcept
Contract_Action context Encounter or Episode with primary association to specified term activity. Reference
Contract_Action contextLinkId Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. string
Contract_Action _contextLinkId Extensions for contextLinkId Element
Contract_Action occurrenceDateTime When action happens. notDefined
Contract_Action _occurrenceDateTime Extensions for occurrenceDateTime Element
Contract_Action occurrencePeriod When action happens. Period
Contract_Action occurrenceTiming When action happens. Timing
Contract_Action requester Who or what initiated the action and has responsibility for its activation. Reference
Contract_Action requesterLinkId Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse. string
Contract_Action _requesterLinkId Extensions for requesterLinkId Element
Contract_Action performerType The type of individual that is desired or required to perform or not perform the action. CodeableConcept
Contract_Action performerRole The type of role or competency of an individual desired or required to perform or not perform the action. CodeableConcept
Contract_Action performer Indicates who or what is being asked to perform (or not perform) the ction. Reference
Contract_Action performerLinkId Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. string
Contract_Action _performerLinkId Extensions for performerLinkId Element
Contract_Action reasonCode Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. CodeableConcept
Contract_Action reasonReference Indicates another resource whose existence justifies permitting or not permitting this action. Reference
Contract_Action reason Describes why the action is to be performed or not performed in textual form. string
Contract_Action _reason Extensions for reason Element
Contract_Action reasonLinkId Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse. string
Contract_Action _reasonLinkId Extensions for reasonLinkId Element
Contract_Action note Comments made about the term action made by the requester, performer, subject or other participants. Annotation
Contract_Action securityLabelNumber Security labels that protects the action. unsignedInt
Contract_Action _securityLabelNumber Extensions for securityLabelNumber Element
Contract_Answer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Answer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Answer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Answer valueBoolean Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueBoolean Extensions for valueBoolean Element
Contract_Answer valueDecimal Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueDecimal Extensions for valueDecimal Element
Contract_Answer valueInteger Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueInteger Extensions for valueInteger Element
Contract_Answer valueDate Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueDate Extensions for valueDate Element
Contract_Answer valueDateTime Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueDateTime Extensions for valueDateTime Element
Contract_Answer valueTime Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueTime Extensions for valueTime Element
Contract_Answer valueString Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueString Extensions for valueString Element
Contract_Answer valueUri Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. notDefined
Contract_Answer _valueUri Extensions for valueUri Element
Contract_Answer valueAttachment Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. Attachment
Contract_Answer valueCoding Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. Coding
Contract_Answer valueQuantity Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. Quantity
Contract_Answer valueReference Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. Reference
Contract_Asset id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Asset extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Asset modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Asset scope Differentiates the kind of the asset . CodeableConcept
Contract_Asset type Target entity type about which the term may be concerned. CodeableConcept
Contract_Asset typeReference Associated entities. Reference
Contract_Asset subtype May be a subtype or part of an offered asset. CodeableConcept
Contract_Asset relationship Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree. Coding
Contract_Asset context Circumstance of the asset. Contract_Context
Contract_Asset condition Description of the quality and completeness of the asset that imay be a factor in its valuation. string
Contract_Asset _condition Extensions for condition Element
Contract_Asset periodType Type of Asset availability for use or ownership. CodeableConcept
Contract_Asset period Asset relevant contractual time period. Period
Contract_Asset usePeriod Time period of asset use. Period
Contract_Asset text Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract. string
Contract_Asset _text Extensions for text Element
Contract_Asset linkId Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse. string
Contract_Asset _linkId Extensions for linkId Element
Contract_Asset answer Response to assets. Contract_Answer
Contract_Asset securityLabelNumber Security labels that protects the asset. unsignedInt
Contract_Asset _securityLabelNumber Extensions for securityLabelNumber Element
Contract_Asset valuedItem Contract Valued Item List. Contract_ValuedItem
Contract_ContentDefinition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_ContentDefinition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_ContentDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_ContentDefinition type 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. CodeableConcept
Contract_ContentDefinition subType Detailed Precusory content type. CodeableConcept
Contract_ContentDefinition publisher The individual or organization that published the Contract precursor content. Reference
Contract_ContentDefinition publicationDate The date (and optionally time) when the contract 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 contract changes. dateTime
Contract_ContentDefinition _publicationDate Extensions for publicationDate Element
Contract_ContentDefinition publicationStatus draft | active | retired | unknown. code
Contract_ContentDefinition _publicationStatus Extensions for publicationStatus Element
Contract_ContentDefinition copyright A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content. markdown
Contract_ContentDefinition _copyright Extensions for copyright Element
Contract_Context id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Context extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Context modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Context reference Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction. Reference
Contract_Context code Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location. CodeableConcept
Contract_Context text Context description. string
Contract_Context _text Extensions for text Element
Contract_Friendly id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Friendly extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Friendly modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Friendly contentAttachment Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability. Attachment
Contract_Friendly contentReference Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability. Reference
Contract_Legal id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Legal extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Legal modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Legal contentAttachment Contract legal text in human renderable form. Attachment
Contract_Legal contentReference Contract legal text in human renderable form. Reference
Contract_Offer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Offer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Offer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Offer identifier Unique identifier for this particular Contract Provision. Identifier
Contract_Offer party Offer Recipient. Contract_Party
Contract_Offer topic 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). Reference
Contract_Offer type Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. CodeableConcept
Contract_Offer decision Type of choice made by accepting party with respect to an offer made by an offeror/ grantee. CodeableConcept
Contract_Offer decisionMode How the decision about a Contract was conveyed. CodeableConcept
Contract_Offer answer Response to offer text. Contract_Answer
Contract_Offer text Human readable form of this Contract Offer. string
Contract_Offer _text Extensions for text Element
Contract_Offer linkId The id of the clause or question text of the offer in the referenced questionnaire/response. string
Contract_Offer _linkId Extensions for linkId Element
Contract_Offer securityLabelNumber Security labels that protects the offer. unsignedInt
Contract_Offer _securityLabelNumber Extensions for securityLabelNumber Element
Contract_Party id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Party extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Party modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Party reference Participant in the offer. Reference
Contract_Party role How the party participates in the offer. CodeableConcept
Contract_Rule id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Rule extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Rule modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Rule contentAttachment Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal). Attachment
Contract_Rule contentReference Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal). Reference
Contract_SecurityLabel id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_SecurityLabel extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_SecurityLabel modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_SecurityLabel number Number used to link this term or term element to the applicable Security Label. unsignedInt
Contract_SecurityLabel _number Extensions for number Element
Contract_SecurityLabel classification Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements. Coding
Contract_SecurityLabel category Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements. Coding
Contract_SecurityLabel control Security label privacy tag that species the manner in which term and/or term elements are to be protected. Coding
Contract_Signer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Signer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Signer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Signer type Role of this Contract signer, e.g. notary, grantee. Coding
Contract_Signer party Party which is a signator to this Contract. Reference
Contract_Signer signature Legally binding Contract DSIG signature contents in Base64. Signature
Contract_Subject id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Subject extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Subject modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Subject reference The entity the action is performed or not performed on or for. Reference
Contract_Subject role Role type of agent assigned roles in this Contract. CodeableConcept
Contract_Term id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_Term extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_Term modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_Term identifier Unique identifier for this particular Contract Provision. Identifier
Contract_Term issued When this Contract Provision was issued. dateTime
Contract_Term _issued Extensions for issued Element
Contract_Term applies Relevant time or time-period when this Contract Provision is applicable. Period
Contract_Term topicCodeableConcept The entity that the term applies to. CodeableConcept
Contract_Term topicReference The entity that the term applies to. Reference
Contract_Term type 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. CodeableConcept
Contract_Term subType A specialized legal clause or condition based on overarching contract type. CodeableConcept
Contract_Term text Statement of a provision in a policy or a contract. string
Contract_Term _text Extensions for text Element
Contract_Term securityLabel Security labels that protect the handling of information about the term and its elements, which may be specifically identified.. Contract_SecurityLabel
Contract_Term offer The matter of concern in the context of this provision of the agrement. Contract_Offer
Contract_Term asset Contract Term Asset List. Contract_Asset
Contract_Term action An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. Contract_Action
Contract_Term group Nested group of Contract Provisions. Contract_Term
Contract_ValuedItem id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contract_ValuedItem extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contract_ValuedItem modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Contract_ValuedItem entityCodeableConcept Specific type of Contract Valued Item that may be priced. CodeableConcept
Contract_ValuedItem entityReference Specific type of Contract Valued Item that may be priced. Reference
Contract_ValuedItem identifier Identifies a Contract Valued Item instance. Identifier
Contract_ValuedItem effectiveTime Indicates the time during which this Contract ValuedItem information is effective. dateTime
Contract_ValuedItem _effectiveTime Extensions for effectiveTime Element
Contract_ValuedItem quantity Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances. Quantity
Contract_ValuedItem unitPrice A Contract Valued Item unit valuation measure. Money
Contract_ValuedItem factor 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. decimal
Contract_ValuedItem _factor Extensions for factor Element
Contract_ValuedItem points 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. decimal
Contract_ValuedItem _points Extensions for points Element
Contract_ValuedItem net 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. Money
Contract_ValuedItem payment Terms of valuation. string
Contract_ValuedItem _payment Extensions for payment Element
Contract_ValuedItem paymentDate When payment is due. dateTime
Contract_ValuedItem _paymentDate Extensions for paymentDate Element
Contract_ValuedItem responsible Who will make payment. Reference
Contract_ValuedItem recipient Who will receive payment. Reference
Contract_ValuedItem linkId Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse. string
Contract_ValuedItem _linkId Extensions for linkId Element
Contract_ValuedItem securityLabelNumber A set of security labels that define which terms are controlled by this condition. unsignedInt
Contract_ValuedItem _securityLabelNumber Extensions for securityLabelNumber Element
Contributor id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Contributor extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Contributor type The type of contributor. enum values:
author
editor
reviewer
endorser
Contributor _type Extensions for type Element
Contributor name The name of the individual or organization responsible for the contribution. string
Contributor _name Extensions for name Element
Contributor contact Contact details to assist a user in finding and communicating with the contributor. ContactDetail
Count id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Count extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Count value The value of the measured amount. The value includes an implicit precision in the presentation of the value. decimal
Count _value Extensions for value Element
Count comparator 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. enum values:
<
<=
>=
>
Count _comparator Extensions for comparator Element
Count unit A human-readable form of the unit. string
Count _unit Extensions for unit Element
Count system The identification of the system that provides the coded form of the unit. uri
Count _system Extensions for system Element
Count code A computer processable form of the unit in some unit representation system. code
Count _code Extensions for code Element
Coverage resourceType This is a Coverage resource Coverage
Coverage id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Coverage meta 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. Meta
Coverage implicitRules 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. uri
Coverage _implicitRules Extensions for implicitRules Element
Coverage language The base language in which the resource is written. code
Coverage _language Extensions for language Element
Coverage text 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. Narrative
Coverage contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Coverage extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Coverage modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Coverage identifier A unique identifier assigned to this coverage. Identifier
Coverage status The status of the resource instance. code
Coverage _status Extensions for status Element
Coverage type The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization. CodeableConcept
Coverage policyHolder The party who 'owns' the insurance policy. Reference
Coverage subscriber 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. Reference
Coverage subscriberId The insurer assigned ID for the Subscriber. string
Coverage _subscriberId Extensions for subscriberId Element
Coverage beneficiary The party who benefits from the insurance coverage; the patient when products and/or services are provided. Reference
Coverage dependent A unique identifier for a dependent under the coverage. string
Coverage _dependent Extensions for dependent Element
Coverage relationship The relationship of beneficiary (patient) to the subscriber. CodeableConcept
Coverage period 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. Period
Coverage payor The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. Reference
Coverage class A suite of underwriter specific classifiers. Coverage_Class
Coverage order 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. positiveInt
Coverage _order Extensions for order Element
Coverage network 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. string
Coverage _network Extensions for network Element
Coverage costToBeneficiary 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. Coverage_CostToBeneficiary
Coverage subrogation When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs. boolean
Coverage _subrogation Extensions for subrogation Element
Coverage contract The policy(s) which constitute this insurance coverage. Reference
CoverageEligibilityRequest resourceType This is a CoverageEligibilityRequest resource CoverageEligibilityRequest
CoverageEligibilityRequest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CoverageEligibilityRequest meta 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. Meta
CoverageEligibilityRequest implicitRules 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. uri
CoverageEligibilityRequest _implicitRules Extensions for implicitRules Element
CoverageEligibilityRequest language The base language in which the resource is written. code
CoverageEligibilityRequest _language Extensions for language Element
CoverageEligibilityRequest text 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. Narrative
CoverageEligibilityRequest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CoverageEligibilityRequest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityRequest identifier A unique identifier assigned to this coverage eligiblity request. Identifier
CoverageEligibilityRequest status The status of the resource instance. code
CoverageEligibilityRequest _status Extensions for status Element
CoverageEligibilityRequest priority When the requestor expects the processor to complete processing. CodeableConcept
CoverageEligibilityRequest purpose 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. enum values:
auth-requirements
benefits
discovery
validation
CoverageEligibilityRequest _purpose Extensions for purpose Element
CoverageEligibilityRequest patient The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. Reference
CoverageEligibilityRequest servicedDate The date or dates when the enclosed suite of services were performed or completed. notDefined
CoverageEligibilityRequest _servicedDate Extensions for servicedDate Element
CoverageEligibilityRequest servicedPeriod The date or dates when the enclosed suite of services were performed or completed. Period
CoverageEligibilityRequest created The date when this resource was created. dateTime
CoverageEligibilityRequest _created Extensions for created Element
CoverageEligibilityRequest enterer Person who created the request. Reference
CoverageEligibilityRequest provider The provider which is responsible for the request. Reference
CoverageEligibilityRequest insurer The Insurer who issued the coverage in question and is the recipient of the request. Reference
CoverageEligibilityRequest facility Facility where the services are intended to be provided. Reference
CoverageEligibilityRequest supportingInfo Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. CoverageEligibilityRequest_SupportingInfo
CoverageEligibilityRequest insurance Financial instruments for reimbursement for the health care products and services. CoverageEligibilityRequest_Insurance
CoverageEligibilityRequest item 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
CoverageEligibilityRequest_Diagnosis id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityRequest_Diagnosis extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityRequest_Diagnosis modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityRequest_Diagnosis diagnosisCodeableConcept The nature of illness or problem in a coded form or as a reference to an external defined Condition. CodeableConcept
CoverageEligibilityRequest_Diagnosis diagnosisReference The nature of illness or problem in a coded form or as a reference to an external defined Condition. Reference
CoverageEligibilityRequest_Insurance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityRequest_Insurance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityRequest_Insurance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityRequest_Insurance focal A flag to indicate that this Coverage is to be used for evaluation of this request when set to true. boolean
CoverageEligibilityRequest_Insurance _focal Extensions for focal Element
CoverageEligibilityRequest_Insurance coverage 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. Reference
CoverageEligibilityRequest_Insurance businessArrangement A business agreement number established between the provider and the insurer for special business processing purposes. string
CoverageEligibilityRequest_Insurance _businessArrangement Extensions for businessArrangement Element
CoverageEligibilityRequest_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityRequest_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityRequest_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityRequest_Item supportingInfoSequence Exceptions, special conditions and supporting information applicable for this service or product line. positiveInt
CoverageEligibilityRequest_Item _supportingInfoSequence Extensions for supportingInfoSequence Element
CoverageEligibilityRequest_Item category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
CoverageEligibilityRequest_Item productOrService This contains the product, service, drug or other billing code for the item. CodeableConcept
CoverageEligibilityRequest_Item modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
CoverageEligibilityRequest_Item provider The practitioner who is responsible for the product or service to be rendered to the patient. Reference
CoverageEligibilityRequest_Item quantity The number of repetitions of a service or product. Quantity
CoverageEligibilityRequest_Item unitPrice The amount charged to the patient by the provider for a single unit. Money
CoverageEligibilityRequest_Item facility Facility where the services will be provided. Reference
CoverageEligibilityRequest_Item diagnosis Patient diagnosis for which care is sought. CoverageEligibilityRequest_Diagnosis
CoverageEligibilityRequest_Item detail The plan/proposal/order describing the proposed service in detail. Reference
CoverageEligibilityRequest_SupportingInfo id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityRequest_SupportingInfo extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityRequest_SupportingInfo modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityRequest_SupportingInfo sequence A number to uniquely identify supporting information entries. positiveInt
CoverageEligibilityRequest_SupportingInfo _sequence Extensions for sequence Element
CoverageEligibilityRequest_SupportingInfo information Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Reference
CoverageEligibilityRequest_SupportingInfo appliesToAll The supporting materials are applicable for all detail items, product/servce categories and specific billing codes. boolean
CoverageEligibilityRequest_SupportingInfo _appliesToAll Extensions for appliesToAll Element
CoverageEligibilityResponse resourceType This is a CoverageEligibilityResponse resource CoverageEligibilityResponse
CoverageEligibilityResponse id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
CoverageEligibilityResponse meta 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. Meta
CoverageEligibilityResponse implicitRules 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. uri
CoverageEligibilityResponse _implicitRules Extensions for implicitRules Element
CoverageEligibilityResponse language The base language in which the resource is written. code
CoverageEligibilityResponse _language Extensions for language Element
CoverageEligibilityResponse text 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. Narrative
CoverageEligibilityResponse contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
CoverageEligibilityResponse extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityResponse modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityResponse identifier A unique identifier assigned to this coverage eligiblity request. Identifier
CoverageEligibilityResponse status The status of the resource instance. code
CoverageEligibilityResponse _status Extensions for status Element
CoverageEligibilityResponse purpose 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. enum values:
auth-requirements
benefits
discovery
validation
CoverageEligibilityResponse _purpose Extensions for purpose Element
CoverageEligibilityResponse patient The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. Reference
CoverageEligibilityResponse servicedDate The date or dates when the enclosed suite of services were performed or completed. notDefined
CoverageEligibilityResponse _servicedDate Extensions for servicedDate Element
CoverageEligibilityResponse servicedPeriod The date or dates when the enclosed suite of services were performed or completed. Period
CoverageEligibilityResponse created The date this resource was created. dateTime
CoverageEligibilityResponse _created Extensions for created Element
CoverageEligibilityResponse requestor The provider which is responsible for the request. Reference
CoverageEligibilityResponse request Reference to the original request resource. Reference
CoverageEligibilityResponse outcome The outcome of the request processing. enum values:
queued
complete
error
partial
CoverageEligibilityResponse _outcome Extensions for outcome Element
CoverageEligibilityResponse disposition A human readable description of the status of the adjudication. string
CoverageEligibilityResponse _disposition Extensions for disposition Element
CoverageEligibilityResponse insurer The Insurer who issued the coverage in question and is the author of the response. Reference
CoverageEligibilityResponse insurance Financial instruments for reimbursement for the health care products and services. CoverageEligibilityResponse_Insurance
CoverageEligibilityResponse preAuthRef A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred. string
CoverageEligibilityResponse _preAuthRef Extensions for preAuthRef Element
CoverageEligibilityResponse form A code for the form to be used for printing the content. CodeableConcept
CoverageEligibilityResponse error Errors encountered during the processing of the request. CoverageEligibilityResponse_Error
CoverageEligibilityResponse_Benefit id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityResponse_Benefit extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityResponse_Benefit modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityResponse_Benefit type Classification of benefit being provided. CodeableConcept
CoverageEligibilityResponse_Benefit allowedUnsignedInt The quantity of the benefit which is permitted under the coverage. notDefined
CoverageEligibilityResponse_Benefit _allowedUnsignedInt Extensions for allowedUnsignedInt Element
CoverageEligibilityResponse_Benefit allowedString The quantity of the benefit which is permitted under the coverage. notDefined
CoverageEligibilityResponse_Benefit _allowedString Extensions for allowedString Element
CoverageEligibilityResponse_Benefit allowedMoney The quantity of the benefit which is permitted under the coverage. Money
CoverageEligibilityResponse_Benefit usedUnsignedInt The quantity of the benefit which have been consumed to date. notDefined
CoverageEligibilityResponse_Benefit _usedUnsignedInt Extensions for usedUnsignedInt Element
CoverageEligibilityResponse_Benefit usedString The quantity of the benefit which have been consumed to date. notDefined
CoverageEligibilityResponse_Benefit _usedString Extensions for usedString Element
CoverageEligibilityResponse_Benefit usedMoney The quantity of the benefit which have been consumed to date. Money
CoverageEligibilityResponse_Error id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityResponse_Error extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityResponse_Error modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityResponse_Error code An error code,from a specified code system, which details why the eligibility check could not be performed. CodeableConcept
CoverageEligibilityResponse_Insurance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityResponse_Insurance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityResponse_Insurance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityResponse_Insurance coverage 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. Reference
CoverageEligibilityResponse_Insurance inforce Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates. boolean
CoverageEligibilityResponse_Insurance _inforce Extensions for inforce Element
CoverageEligibilityResponse_Insurance benefitPeriod The term of the benefits documented in this response. Period
CoverageEligibilityResponse_Insurance item Benefits and optionally current balances, and authorization details by category or service. CoverageEligibilityResponse_Item
CoverageEligibilityResponse_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
CoverageEligibilityResponse_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
CoverageEligibilityResponse_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
CoverageEligibilityResponse_Item category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
CoverageEligibilityResponse_Item productOrService This contains the product, service, drug or other billing code for the item. CodeableConcept
CoverageEligibilityResponse_Item modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
CoverageEligibilityResponse_Item provider The practitioner who is eligible for the provision of the product or service. Reference
CoverageEligibilityResponse_Item excluded 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. boolean
CoverageEligibilityResponse_Item _excluded Extensions for excluded Element
CoverageEligibilityResponse_Item name A short name or tag for the benefit. string
CoverageEligibilityResponse_Item _name Extensions for name Element
CoverageEligibilityResponse_Item description A richer description of the benefit or services covered. string
CoverageEligibilityResponse_Item _description Extensions for description Element
CoverageEligibilityResponse_Item network Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. CodeableConcept
CoverageEligibilityResponse_Item unit Indicates if the benefits apply to an individual or to the family. CodeableConcept
CoverageEligibilityResponse_Item term The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. CodeableConcept
CoverageEligibilityResponse_Item benefit Benefits used to date. CoverageEligibilityResponse_Benefit
CoverageEligibilityResponse_Item authorizationRequired A boolean flag indicating whether a preauthorization is required prior to actual service delivery. boolean
CoverageEligibilityResponse_Item _authorizationRequired Extensions for authorizationRequired Element
CoverageEligibilityResponse_Item authorizationSupporting Codes or comments regarding information or actions associated with the preauthorization. CodeableConcept
CoverageEligibilityResponse_Item authorizationUrl A web location for obtaining requirements or descriptive information regarding the preauthorization. uri
CoverageEligibilityResponse_Item _authorizationUrl Extensions for authorizationUrl Element
Coverage_Class id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Coverage_Class extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Coverage_Class modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Coverage_Class type The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan. CodeableConcept
Coverage_Class value The alphanumeric string value associated with the insurer issued label. string
Coverage_Class _value Extensions for value Element
Coverage_Class name A short description for the class. string
Coverage_Class _name Extensions for name Element
Coverage_CostToBeneficiary id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Coverage_CostToBeneficiary extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Coverage_CostToBeneficiary modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Coverage_CostToBeneficiary type The category of patient centric costs associated with treatment. CodeableConcept
Coverage_CostToBeneficiary valueQuantity The amount due from the patient for the cost category. Quantity
Coverage_CostToBeneficiary valueMoney The amount due from the patient for the cost category. Money
Coverage_CostToBeneficiary exception A suite of codes indicating exceptions or reductions to patient costs and their effective periods. Coverage_Exception
Coverage_Exception id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Coverage_Exception extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Coverage_Exception modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Coverage_Exception type The code for the specific exception. CodeableConcept
Coverage_Exception period The timeframe during when the exception is in force. Period
DataRequirement id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DataRequirement extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DataRequirement type 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. code
DataRequirement _type Extensions for type Element
DataRequirement profile The profile of the required data, specified as the uri of the profile definition. canonical
DataRequirement subjectCodeableConcept The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. CodeableConcept
DataRequirement subjectReference The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. Reference
DataRequirement mustSupport Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). string
DataRequirement _mustSupport Extensions for mustSupport Element
DataRequirement codeFilter 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
DataRequirement dateFilter 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
DataRequirement limit Specifies a maximum number of results that are required (uses the _count search parameter). positiveInt
DataRequirement _limit Extensions for limit Element
DataRequirement sort Specifies the order of the results to be returned. DataRequirement_Sort
DataRequirement_CodeFilter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DataRequirement_CodeFilter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DataRequirement_CodeFilter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DataRequirement_CodeFilter path The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept. string
DataRequirement_CodeFilter _path Extensions for path Element
DataRequirement_CodeFilter searchParam 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. string
DataRequirement_CodeFilter _searchParam Extensions for searchParam Element
DataRequirement_CodeFilter valueSet 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. canonical
DataRequirement_CodeFilter code 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. Coding
DataRequirement_DateFilter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DataRequirement_DateFilter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DataRequirement_DateFilter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DataRequirement_DateFilter path The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing. string
DataRequirement_DateFilter _path Extensions for path Element
DataRequirement_DateFilter searchParam 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. string
DataRequirement_DateFilter _searchParam Extensions for searchParam Element
DataRequirement_DateFilter valueDateTime The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now. notDefined
DataRequirement_DateFilter _valueDateTime Extensions for valueDateTime Element
DataRequirement_DateFilter valuePeriod The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now. Period
DataRequirement_DateFilter valueDuration The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now. Duration
DataRequirement_Sort id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DataRequirement_Sort extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DataRequirement_Sort modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DataRequirement_Sort path 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. string
DataRequirement_Sort _path Extensions for path Element
DataRequirement_Sort direction The direction of the sort, ascending or descending. enum values:
ascending
descending
DataRequirement_Sort _direction Extensions for direction Element
DetectedIssue resourceType This is a DetectedIssue resource DetectedIssue
DetectedIssue id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DetectedIssue meta 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. Meta
DetectedIssue implicitRules 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. uri
DetectedIssue _implicitRules Extensions for implicitRules Element
DetectedIssue language The base language in which the resource is written. code
DetectedIssue _language Extensions for language Element
DetectedIssue text 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. Narrative
DetectedIssue contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DetectedIssue extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DetectedIssue modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DetectedIssue identifier Business identifier associated with the detected issue record. Identifier
DetectedIssue status Indicates the status of the detected issue. code
DetectedIssue _status Extensions for status Element
DetectedIssue code Identifies the general type of issue identified. CodeableConcept
DetectedIssue severity Indicates the degree of importance associated with the identified issue based on the potential impact on the patient. enum values:
high
moderate
low
DetectedIssue _severity Extensions for severity Element
DetectedIssue patient Indicates the patient whose record the detected issue is associated with. Reference
DetectedIssue identifiedDateTime The date or period when the detected issue was initially identified. notDefined
DetectedIssue _identifiedDateTime Extensions for identifiedDateTime Element
DetectedIssue identifiedPeriod The date or period when the detected issue was initially identified. Period
DetectedIssue author Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review. Reference
DetectedIssue implicated Indicates the resource representing the current activity or proposed activity that is potentially problematic. Reference
DetectedIssue evidence Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport. DetectedIssue_Evidence
DetectedIssue detail A textual explanation of the detected issue. string
DetectedIssue _detail Extensions for detail Element
DetectedIssue reference The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified. uri
DetectedIssue _reference Extensions for reference Element
DetectedIssue mitigation 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
DetectedIssue_Evidence id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DetectedIssue_Evidence extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DetectedIssue_Evidence modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DetectedIssue_Evidence code A manifestation that led to the recording of this detected issue. CodeableConcept
DetectedIssue_Evidence detail Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport. Reference
DetectedIssue_Mitigation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DetectedIssue_Mitigation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DetectedIssue_Mitigation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DetectedIssue_Mitigation action Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue. CodeableConcept
DetectedIssue_Mitigation date Indicates when the mitigating action was documented. dateTime
DetectedIssue_Mitigation _date Extensions for date Element
DetectedIssue_Mitigation author Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring. Reference
Device resourceType This is a Device resource Device
Device id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Device meta 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. Meta
Device implicitRules 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. uri
Device _implicitRules Extensions for implicitRules Element
Device language The base language in which the resource is written. code
Device _language Extensions for language Element
Device text 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. Narrative
Device contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Device extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Device modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Device identifier Unique instance identifiers assigned to a device by manufacturers other organizations or owners. Identifier
Device definition The reference to the definition for the device. Reference
Device udiCarrier 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. Device_UdiCarrier
Device status Status of the Device availability. enum values:
active
inactive
entered-in-error
unknown
Device _status Extensions for status Element
Device statusReason Reason for the dtatus of the Device availability. CodeableConcept
Device distinctIdentifier The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. string
Device _distinctIdentifier Extensions for distinctIdentifier Element
Device manufacturer A name of the manufacturer. string
Device _manufacturer Extensions for manufacturer Element
Device manufactureDate The date and time when the device was manufactured. dateTime
Device _manufactureDate Extensions for manufactureDate Element
Device expirationDate The date and time beyond which this device is no longer valid or should not be used (if applicable). dateTime
Device _expirationDate Extensions for expirationDate Element
Device lotNumber Lot number assigned by the manufacturer. string
Device _lotNumber Extensions for lotNumber Element
Device serialNumber The serial number assigned by the organization when the device was manufactured. string
Device _serialNumber Extensions for serialNumber Element
Device deviceName 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_DeviceName
Device modelNumber The model number for the device. string
Device _modelNumber Extensions for modelNumber Element
Device partNumber The part number of the device. string
Device _partNumber Extensions for partNumber Element
Device type The kind or type of device. CodeableConcept
Device specialization The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication. Device_Specialization
Device version The actual design of the device or software version running on the device. Device_Version
Device property The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties. Device_Property
Device patient Patient information, If the device is affixed to a person. Reference
Device owner An organization that is responsible for the provision and ongoing maintenance of the device. Reference
Device contact Contact details for an organization or a particular human that is responsible for the device. ContactPoint
Device location The place where the device can be found. Reference
Device url A network address on which the device may be contacted directly. uri
Device _url Extensions for url Element
Device note Descriptive information, usage information or implantation information that is not captured in an existing element. Annotation
Device safety Provides additional safety characteristics about a medical device. For example devices containing latex. CodeableConcept
Device parent The parent device. Reference
DeviceDefinition resourceType This is a DeviceDefinition resource DeviceDefinition
DeviceDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DeviceDefinition meta 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. Meta
DeviceDefinition implicitRules 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. uri
DeviceDefinition _implicitRules Extensions for implicitRules Element
DeviceDefinition language The base language in which the resource is written. code
DeviceDefinition _language Extensions for language Element
DeviceDefinition text 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. Narrative
DeviceDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DeviceDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceDefinition identifier Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. Identifier
DeviceDefinition udiDeviceIdentifier 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
DeviceDefinition manufacturerString A name of the manufacturer. notDefined
DeviceDefinition _manufacturerString Extensions for manufacturerString Element
DeviceDefinition manufacturerReference A name of the manufacturer. Reference
DeviceDefinition deviceName A name given to the device to identify it. DeviceDefinition_DeviceName
DeviceDefinition modelNumber The model number for the device. string
DeviceDefinition _modelNumber Extensions for modelNumber Element
DeviceDefinition type What kind of device or device system this is. CodeableConcept
DeviceDefinition specialization The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication. DeviceDefinition_Specialization
DeviceDefinition version The available versions of the device, e.g., software versions. string
DeviceDefinition _version Extensions for version Element
DeviceDefinition safety Safety characteristics of the device. CodeableConcept
DeviceDefinition shelfLifeStorage Shelf Life and storage information. ProductShelfLife
DeviceDefinition physicalCharacteristics Dimensions, color etc. ProdCharacteristic
DeviceDefinition languageCode Language code for the human-readable text strings produced by the device (all supported). CodeableConcept
DeviceDefinition capability Device capabilities. DeviceDefinition_Capability
DeviceDefinition property The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties. DeviceDefinition_Property
DeviceDefinition owner An organization that is responsible for the provision and ongoing maintenance of the device. Reference
DeviceDefinition contact Contact details for an organization or a particular human that is responsible for the device. ContactPoint
DeviceDefinition url A network address on which the device may be contacted directly. uri
DeviceDefinition _url Extensions for url Element
DeviceDefinition onlineInformation Access to on-line information about the device. uri
DeviceDefinition _onlineInformation Extensions for onlineInformation Element
DeviceDefinition note Descriptive information, usage information or implantation information that is not captured in an existing element. Annotation
DeviceDefinition quantity The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product). Quantity
DeviceDefinition parentDevice The parent device it can be part of. Reference
DeviceDefinition material A substance used to create the material(s) of which the device is made. DeviceDefinition_Material
DeviceDefinition_Capability id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceDefinition_Capability extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceDefinition_Capability modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceDefinition_Capability type Type of capability. CodeableConcept
DeviceDefinition_Capability description Description of capability. CodeableConcept
DeviceDefinition_DeviceName id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceDefinition_DeviceName extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceDefinition_DeviceName modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceDefinition_DeviceName name The name of the device. string
DeviceDefinition_DeviceName _name Extensions for name Element
DeviceDefinition_DeviceName type The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. enum values:
udi-label-name
user-friendly-name
patient-reported-name
manufacturer-name
model-name
other
DeviceDefinition_DeviceName _type Extensions for type Element
DeviceDefinition_Material id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceDefinition_Material extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceDefinition_Material modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceDefinition_Material substance The substance. CodeableConcept
DeviceDefinition_Material alternate Indicates an alternative material of the device. boolean
DeviceDefinition_Material _alternate Extensions for alternate Element
DeviceDefinition_Material allergenicIndicator Whether the substance is a known or suspected allergen. boolean
DeviceDefinition_Material _allergenicIndicator Extensions for allergenicIndicator Element
DeviceDefinition_Property id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceDefinition_Property extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceDefinition_Property modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceDefinition_Property type Code that specifies the property DeviceDefinitionPropetyCode (Extensible). CodeableConcept
DeviceDefinition_Property valueQuantity Property value as a quantity. Quantity
DeviceDefinition_Property valueCode Property value as a code, e.g., NTP4 (synced to NTP). CodeableConcept
DeviceDefinition_Specialization id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceDefinition_Specialization extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceDefinition_Specialization modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceDefinition_Specialization systemType The standard that is used to operate and communicate. string
DeviceDefinition_Specialization _systemType Extensions for systemType Element
DeviceDefinition_Specialization version The version of the standard that is used to operate and communicate. string
DeviceDefinition_Specialization _version Extensions for version Element
DeviceDefinition_UdiDeviceIdentifier id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceDefinition_UdiDeviceIdentifier extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceDefinition_UdiDeviceIdentifier modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceDefinition_UdiDeviceIdentifier deviceIdentifier The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier. string
DeviceDefinition_UdiDeviceIdentifier _deviceIdentifier Extensions for deviceIdentifier Element
DeviceDefinition_UdiDeviceIdentifier issuer The organization that assigns the identifier algorithm. uri
DeviceDefinition_UdiDeviceIdentifier _issuer Extensions for issuer Element
DeviceDefinition_UdiDeviceIdentifier jurisdiction The jurisdiction to which the deviceIdentifier applies. uri
DeviceDefinition_UdiDeviceIdentifier _jurisdiction Extensions for jurisdiction Element
DeviceMetric resourceType This is a DeviceMetric resource DeviceMetric
DeviceMetric id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DeviceMetric meta 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. Meta
DeviceMetric implicitRules 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. uri
DeviceMetric _implicitRules Extensions for implicitRules Element
DeviceMetric language The base language in which the resource is written. code
DeviceMetric _language Extensions for language Element
DeviceMetric text 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. Narrative
DeviceMetric contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DeviceMetric extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceMetric modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceMetric identifier Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. Identifier
DeviceMetric type Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc. CodeableConcept
DeviceMetric unit Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. CodeableConcept
DeviceMetric source Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. Reference
DeviceMetric parent Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. Reference
DeviceMetric operationalStatus Indicates current operational state of the device. For example: On, Off, Standby, etc. enum values:
on
off
standby
entered-in-error
DeviceMetric _operationalStatus Extensions for operationalStatus Element
DeviceMetric color Describes the color representation for the metric. 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 for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta. enum values:
black
red
green
yellow
blue
magenta
cyan
white
DeviceMetric _color Extensions for color Element
DeviceMetric category Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. enum values:
measurement
setting
calculation
unspecified
DeviceMetric _category Extensions for category Element
DeviceMetric measurementPeriod Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured. Timing
DeviceMetric calibration Describes the calibrations that have been performed or that are required to be performed. DeviceMetric_Calibration
DeviceMetric_Calibration id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceMetric_Calibration extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceMetric_Calibration modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceMetric_Calibration type Describes the type of the calibration method. enum values:
unspecified
offset
gain
two-point
DeviceMetric_Calibration _type Extensions for type Element
DeviceMetric_Calibration state Describes the state of the calibration. enum values:
not-calibrated
calibration-required
calibrated
unspecified
DeviceMetric_Calibration _state Extensions for state Element
DeviceMetric_Calibration time Describes the time last calibration has been performed. instant
DeviceMetric_Calibration _time Extensions for time Element
DeviceRequest resourceType This is a DeviceRequest resource DeviceRequest
DeviceRequest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DeviceRequest meta 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. Meta
DeviceRequest implicitRules 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. uri
DeviceRequest _implicitRules Extensions for implicitRules Element
DeviceRequest language The base language in which the resource is written. code
DeviceRequest _language Extensions for language Element
DeviceRequest text 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. Narrative
DeviceRequest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DeviceRequest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceRequest identifier Identifiers assigned to this order by the orderer or by the receiver. Identifier
DeviceRequest instantiatesCanonical 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. canonical
DeviceRequest instantiatesUri 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. uri
DeviceRequest _instantiatesUri Extensions for instantiatesUri Element
DeviceRequest basedOn Plan/proposal/order fulfilled by this request. Reference
DeviceRequest priorRequest The request takes the place of the referenced completed or terminated request(s). Reference
DeviceRequest groupIdentifier Composite request this is part of. Identifier
DeviceRequest status The status of the request. code
DeviceRequest _status Extensions for status Element
DeviceRequest intent Whether the request is a proposal, plan, an original order or a reflex order. code
DeviceRequest _intent Extensions for intent Element
DeviceRequest priority Indicates how quickly the {{title}} should be addressed with respect to other requests. code
DeviceRequest _priority Extensions for priority Element
DeviceRequest codeReference The details of the device to be used. Reference
DeviceRequest codeCodeableConcept The details of the device to be used. CodeableConcept
DeviceRequest parameter Specific parameters for the ordered item. For example, the prism value for lenses. DeviceRequest_Parameter
DeviceRequest subject The patient who will use the device. Reference
DeviceRequest encounter An encounter that provides additional context in which this request is made. Reference
DeviceRequest occurrenceDateTime 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". notDefined
DeviceRequest _occurrenceDateTime Extensions for occurrenceDateTime Element
DeviceRequest occurrencePeriod 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". Period
DeviceRequest occurrenceTiming 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". Timing
DeviceRequest authoredOn When the request transitioned to being actionable. dateTime
DeviceRequest _authoredOn Extensions for authoredOn Element
DeviceRequest requester The individual who initiated the request and has responsibility for its activation. Reference
DeviceRequest performerType Desired type of performer for doing the diagnostic testing. CodeableConcept
DeviceRequest performer The desired performer for doing the diagnostic testing. Reference
DeviceRequest reasonCode Reason or justification for the use of this device. CodeableConcept
DeviceRequest reasonReference Reason or justification for the use of this device. Reference
DeviceRequest insurance Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. Reference
DeviceRequest supportingInfo 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). Reference
DeviceRequest note 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. Annotation
DeviceRequest relevantHistory Key events in the history of the request. Reference
DeviceRequest_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DeviceRequest_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceRequest_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceRequest_Parameter code A code or string that identifies the device detail being asserted. CodeableConcept
DeviceRequest_Parameter valueCodeableConcept The value of the device detail. CodeableConcept
DeviceRequest_Parameter valueQuantity The value of the device detail. Quantity
DeviceRequest_Parameter valueRange The value of the device detail. Range
DeviceRequest_Parameter valueBoolean The value of the device detail. notDefined
DeviceRequest_Parameter _valueBoolean Extensions for valueBoolean Element
DeviceUseStatement resourceType This is a DeviceUseStatement resource DeviceUseStatement
DeviceUseStatement id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DeviceUseStatement meta 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. Meta
DeviceUseStatement implicitRules 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. uri
DeviceUseStatement _implicitRules Extensions for implicitRules Element
DeviceUseStatement language The base language in which the resource is written. code
DeviceUseStatement _language Extensions for language Element
DeviceUseStatement text 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. Narrative
DeviceUseStatement contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DeviceUseStatement extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DeviceUseStatement modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DeviceUseStatement identifier An external identifier for this statement such as an IRI. Identifier
DeviceUseStatement basedOn A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. Reference
DeviceUseStatement status 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. enum values:
active
completed
entered-in-error
intended
stopped
on-hold
DeviceUseStatement _status Extensions for status Element
DeviceUseStatement subject The patient who used the device. Reference
DeviceUseStatement derivedFrom Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. Reference
DeviceUseStatement timingTiming How often the device was used. Timing
DeviceUseStatement timingPeriod How often the device was used. Period
DeviceUseStatement timingDateTime How often the device was used. notDefined
DeviceUseStatement _timingDateTime Extensions for timingDateTime Element
DeviceUseStatement recordedOn The time at which the statement was made/recorded. dateTime
DeviceUseStatement _recordedOn Extensions for recordedOn Element
DeviceUseStatement source Who reported the device was being used by the patient. Reference
DeviceUseStatement device The details of the device used. Reference
DeviceUseStatement reasonCode Reason or justification for the use of the device. CodeableConcept
DeviceUseStatement reasonReference Indicates another resource whose existence justifies this DeviceUseStatement. Reference
DeviceUseStatement bodySite Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). CodeableConcept
DeviceUseStatement note 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. Annotation
Device_DeviceName id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Device_DeviceName extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Device_DeviceName modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Device_DeviceName name The name of the device. string
Device_DeviceName _name Extensions for name Element
Device_DeviceName type The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. enum values:
udi-label-name
user-friendly-name
patient-reported-name
manufacturer-name
model-name
other
Device_DeviceName _type Extensions for type Element
Device_Property id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Device_Property extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Device_Property modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Device_Property type Code that specifies the property DeviceDefinitionPropetyCode (Extensible). CodeableConcept
Device_Property valueQuantity Property value as a quantity. Quantity
Device_Property valueCode Property value as a code, e.g., NTP4 (synced to NTP). CodeableConcept
Device_Specialization id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Device_Specialization extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Device_Specialization modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Device_Specialization systemType The standard that is used to operate and communicate. CodeableConcept
Device_Specialization version The version of the standard that is used to operate and communicate. string
Device_Specialization _version Extensions for version Element
Device_UdiCarrier id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Device_UdiCarrier extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Device_UdiCarrier modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Device_UdiCarrier deviceIdentifier 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. string
Device_UdiCarrier _deviceIdentifier Extensions for deviceIdentifier Element
Device_UdiCarrier issuer 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-dI, 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. uri
Device_UdiCarrier _issuer Extensions for issuer Element
Device_UdiCarrier jurisdiction 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/fda-udi. uri
Device_UdiCarrier _jurisdiction Extensions for jurisdiction Element
Device_UdiCarrier carrierAIDC 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. base64Binary
Device_UdiCarrier _carrierAIDC Extensions for carrierAIDC Element
Device_UdiCarrier carrierHRF The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device. string
Device_UdiCarrier _carrierHRF Extensions for carrierHRF Element
Device_UdiCarrier entryType A coded entry to indicate how the data was entered. enum values:
barcode
rfid
manual
card
self-reported
unknown
Device_UdiCarrier _entryType Extensions for entryType Element
Device_Version id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Device_Version extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Device_Version modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Device_Version type The type of the device version. CodeableConcept
Device_Version component A single component of the device version. Identifier
Device_Version value The version text. string
Device_Version _value Extensions for value Element
DiagnosticReport resourceType This is a DiagnosticReport resource DiagnosticReport
DiagnosticReport id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DiagnosticReport meta 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. Meta
DiagnosticReport implicitRules 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. uri
DiagnosticReport _implicitRules Extensions for implicitRules Element
DiagnosticReport language The base language in which the resource is written. code
DiagnosticReport _language Extensions for language Element
DiagnosticReport text 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. Narrative
DiagnosticReport contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DiagnosticReport extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DiagnosticReport modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DiagnosticReport identifier Identifiers assigned to this report by the performer or other systems. Identifier
DiagnosticReport basedOn Details concerning a service requested. Reference
DiagnosticReport status The status of the diagnostic report. enum values:
registered
partial
preliminary
final
amended
corrected
appended
cancelled
entered-in-error
unknown
DiagnosticReport _status Extensions for status Element
DiagnosticReport category 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. CodeableConcept
DiagnosticReport code A code or name that describes this diagnostic report. CodeableConcept
DiagnosticReport subject 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. Reference
DiagnosticReport encounter The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. Reference
DiagnosticReport effectiveDateTime 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. notDefined
DiagnosticReport _effectiveDateTime Extensions for effectiveDateTime Element
DiagnosticReport effectivePeriod 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. Period
DiagnosticReport issued The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. instant
DiagnosticReport _issued Extensions for issued Element
DiagnosticReport performer The diagnostic service that is responsible for issuing the report. Reference
DiagnosticReport resultsInterpreter The practitioner or organization that is responsible for the report's conclusions and interpretations. Reference
DiagnosticReport specimen Details about the specimens on which this diagnostic report is based. Reference
DiagnosticReport result [Observations](observation.html) that are part of this diagnostic report. Reference
DiagnosticReport imagingStudy One or more links to full details of any imaging performed during the diagnostic investigation. 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. Reference
DiagnosticReport media A list of key images associated with this report. The images 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
DiagnosticReport conclusion Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. string
DiagnosticReport _conclusion Extensions for conclusion Element
DiagnosticReport conclusionCode One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. CodeableConcept
DiagnosticReport presentedForm Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. Attachment
DiagnosticReport_Media id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DiagnosticReport_Media extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DiagnosticReport_Media modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DiagnosticReport_Media comment A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. string
DiagnosticReport_Media _comment Extensions for comment Element
DiagnosticReport_Media link Reference to the image source. Reference
Distance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Distance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Distance value The value of the measured amount. The value includes an implicit precision in the presentation of the value. decimal
Distance _value Extensions for value Element
Distance comparator 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. enum values:
<
<=
>=
>
Distance _comparator Extensions for comparator Element
Distance unit A human-readable form of the unit. string
Distance _unit Extensions for unit Element
Distance system The identification of the system that provides the coded form of the unit. uri
Distance _system Extensions for system Element
Distance code A computer processable form of the unit in some unit representation system. code
Distance _code Extensions for code Element
DocumentManifest resourceType This is a DocumentManifest resource DocumentManifest
DocumentManifest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DocumentManifest meta 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. Meta
DocumentManifest implicitRules 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. uri
DocumentManifest _implicitRules Extensions for implicitRules Element
DocumentManifest language The base language in which the resource is written. code
DocumentManifest _language Extensions for language Element
DocumentManifest text 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. Narrative
DocumentManifest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DocumentManifest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DocumentManifest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DocumentManifest masterIdentifier A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts. Identifier
DocumentManifest identifier Other identifiers associated with the document manifest, including version independent identifiers. Identifier
DocumentManifest status The status of this document manifest. enum values:
current
superseded
entered-in-error
DocumentManifest _status Extensions for status Element
DocumentManifest type The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest. CodeableConcept
DocumentManifest subject Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case). Reference
DocumentManifest created When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.). dateTime
DocumentManifest _created Extensions for created Element
DocumentManifest author Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included. Reference
DocumentManifest recipient A patient, practitioner, or organization for which this set of documents is intended. Reference
DocumentManifest source Identifies the source system, application, or software that produced the document manifest. uri
DocumentManifest _source Extensions for source Element
DocumentManifest description Human-readable description of the source document. This is sometimes known as the "title". string
DocumentManifest _description Extensions for description Element
DocumentManifest content The list of Resources that consist of the parts of this manifest. Reference
DocumentManifest related Related identifiers or resources associated with the DocumentManifest. DocumentManifest_Related
DocumentManifest_Related id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DocumentManifest_Related extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DocumentManifest_Related modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DocumentManifest_Related identifier Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers. Identifier
DocumentManifest_Related ref Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc. Reference
DocumentReference resourceType This is a DocumentReference resource DocumentReference
DocumentReference id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
DocumentReference meta 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. Meta
DocumentReference implicitRules 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. uri
DocumentReference _implicitRules Extensions for implicitRules Element
DocumentReference language The base language in which the resource is written. code
DocumentReference _language Extensions for language Element
DocumentReference text 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. Narrative
DocumentReference contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
DocumentReference extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DocumentReference modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DocumentReference masterIdentifier Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. Identifier
DocumentReference identifier Other identifiers associated with the document, including version independent identifiers. Identifier
DocumentReference status The status of this document reference. enum values:
current
superseded
entered-in-error
DocumentReference _status Extensions for status Element
DocumentReference docStatus The status of the underlying document. code
DocumentReference _docStatus Extensions for docStatus Element
DocumentReference type 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. CodeableConcept
DocumentReference category 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. CodeableConcept
DocumentReference subject 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). Reference
DocumentReference date When the document reference was created. instant
DocumentReference _date Extensions for date Element
DocumentReference author Identifies who is responsible for adding the information to the document. Reference
DocumentReference authenticator Which person or organization authenticates that this document is valid. Reference
DocumentReference custodian Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. Reference
DocumentReference relatesTo Relationships that this document has with other document references that already exist. DocumentReference_RelatesTo
DocumentReference description Human-readable description of the source document. string
DocumentReference _description Extensions for description Element
DocumentReference securityLabel A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. CodeableConcept
DocumentReference content The document and format referenced. There may be multiple content element repetitions, each with a different format. DocumentReference_Content
DocumentReference context The clinical context in which the document was prepared. DocumentReference_Context
DocumentReference_Content id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DocumentReference_Content extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DocumentReference_Content modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DocumentReference_Content attachment The document or URL of the document along with critical metadata to prove content has integrity. Attachment
DocumentReference_Content format An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. Coding
DocumentReference_Context id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DocumentReference_Context extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DocumentReference_Context modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DocumentReference_Context encounter Describes the clinical encounter or type of care that the document content is associated with. Reference
DocumentReference_Context event 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. CodeableConcept
DocumentReference_Context period The time period over which the service that is described by the document was provided. Period
DocumentReference_Context facilityType The kind of facility where the patient was seen. CodeableConcept
DocumentReference_Context practiceSetting This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. CodeableConcept
DocumentReference_Context sourcePatientInfo The Patient Information as known when the document was published. May be a reference to a version specific, or contained. Reference
DocumentReference_Context related Related identifiers or resources associated with the DocumentReference. Reference
DocumentReference_RelatesTo id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
DocumentReference_RelatesTo extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
DocumentReference_RelatesTo modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
DocumentReference_RelatesTo code The type of relationship that this document has with anther document. enum values:
replaces
transforms
signs
appends
DocumentReference_RelatesTo _code Extensions for code Element
DocumentReference_RelatesTo target The target document of this relationship. Reference
Dosage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Dosage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Dosage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Dosage sequence Indicates the order in which the dosage instructions should be applied or interpreted. integer
Dosage _sequence Extensions for sequence Element
Dosage text Free text dosage instructions e.g. SIG. string
Dosage _text Extensions for text Element
Dosage additionalInstruction 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"). CodeableConcept
Dosage patientInstruction Instructions in terms that are understood by the patient or consumer. string
Dosage _patientInstruction Extensions for patientInstruction Element
Dosage timing When medication should be administered. Timing
Dosage asNeededBoolean Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). notDefined
Dosage _asNeededBoolean Extensions for asNeededBoolean Element
Dosage asNeededCodeableConcept Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). CodeableConcept
Dosage site Body site to administer to. CodeableConcept
Dosage route How drug should enter body. CodeableConcept
Dosage method Technique for administering medication. CodeableConcept
Dosage doseAndRate The amount of medication administered. Dosage_DoseAndRate
Dosage maxDosePerPeriod Upper limit on medication per unit of time. Ratio
Dosage maxDosePerAdministration Upper limit on medication per administration. Quantity
Dosage maxDosePerLifetime Upper limit on medication per lifetime of the patient. Quantity
Dosage_DoseAndRate id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Dosage_DoseAndRate extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Dosage_DoseAndRate modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Dosage_DoseAndRate type The kind of dose or rate specified, for example, ordered or calculated. CodeableConcept
Dosage_DoseAndRate doseRange Amount of medication per dose. Range
Dosage_DoseAndRate doseQuantity Amount of medication per dose. Quantity
Dosage_DoseAndRate rateRatio Amount of medication per unit of time. Ratio
Dosage_DoseAndRate rateRange Amount of medication per unit of time. Range
Dosage_DoseAndRate rateQuantity Amount of medication per unit of time. Quantity
Duration id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Duration extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Duration value The value of the measured amount. The value includes an implicit precision in the presentation of the value. decimal
Duration _value Extensions for value Element
Duration comparator 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. enum values:
<
<=
>=
>
Duration _comparator Extensions for comparator Element
Duration unit A human-readable form of the unit. string
Duration _unit Extensions for unit Element
Duration system The identification of the system that provides the coded form of the unit. uri
Duration _system Extensions for system Element
Duration code A computer processable form of the unit in some unit representation system. code
Duration _code Extensions for code Element
EffectEvidenceSynthesis resourceType This is a EffectEvidenceSynthesis resource EffectEvidenceSynthesis
EffectEvidenceSynthesis id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
EffectEvidenceSynthesis meta 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. Meta
EffectEvidenceSynthesis implicitRules 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. uri
EffectEvidenceSynthesis _implicitRules Extensions for implicitRules Element
EffectEvidenceSynthesis language The base language in which the resource is written. code
EffectEvidenceSynthesis _language Extensions for language Element
EffectEvidenceSynthesis text 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. Narrative
EffectEvidenceSynthesis contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
EffectEvidenceSynthesis extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EffectEvidenceSynthesis modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EffectEvidenceSynthesis url An absolute URI that is used to identify this effect evidence synthesis 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 at which an authoritative instance of this effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis is stored on different servers. uri
EffectEvidenceSynthesis _url Extensions for url Element
EffectEvidenceSynthesis identifier A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance. Identifier
EffectEvidenceSynthesis version The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis 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. string
EffectEvidenceSynthesis _version Extensions for version Element
EffectEvidenceSynthesis name A natural language name identifying the effect evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation. string
EffectEvidenceSynthesis _name Extensions for name Element
EffectEvidenceSynthesis title A short, descriptive, user-friendly title for the effect evidence synthesis. string
EffectEvidenceSynthesis _title Extensions for title Element
EffectEvidenceSynthesis status The status of this effect evidence synthesis. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
EffectEvidenceSynthesis _status Extensions for status Element
EffectEvidenceSynthesis date The date (and optionally time) when the effect evidence synthesis 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 effect evidence synthesis changes. dateTime
EffectEvidenceSynthesis _date Extensions for date Element
EffectEvidenceSynthesis publisher The name of the organization or individual that published the effect evidence synthesis. string
EffectEvidenceSynthesis _publisher Extensions for publisher Element
EffectEvidenceSynthesis contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
EffectEvidenceSynthesis description A free text natural language description of the effect evidence synthesis from a consumer's perspective. markdown
EffectEvidenceSynthesis _description Extensions for description Element
EffectEvidenceSynthesis note A human-readable string to clarify or explain concepts about the resource. Annotation
EffectEvidenceSynthesis useContext 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 effect evidence synthesis instances. UsageContext
EffectEvidenceSynthesis jurisdiction A legal or geographic region in which the effect evidence synthesis is intended to be used. CodeableConcept
EffectEvidenceSynthesis copyright A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis. markdown
EffectEvidenceSynthesis _copyright Extensions for copyright Element
EffectEvidenceSynthesis approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
EffectEvidenceSynthesis _approvalDate Extensions for approvalDate Element
EffectEvidenceSynthesis lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
EffectEvidenceSynthesis _lastReviewDate Extensions for lastReviewDate Element
EffectEvidenceSynthesis effectivePeriod The period during which the effect evidence synthesis content was or is planned to be in active use. Period
EffectEvidenceSynthesis topic Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching. CodeableConcept
EffectEvidenceSynthesis author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
EffectEvidenceSynthesis editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
EffectEvidenceSynthesis reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
EffectEvidenceSynthesis endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
EffectEvidenceSynthesis relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
EffectEvidenceSynthesis synthesisType Type of synthesis eg meta-analysis. CodeableConcept
EffectEvidenceSynthesis studyType Type of study eg randomized trial. CodeableConcept
EffectEvidenceSynthesis population A reference to a EvidenceVariable resource that defines the population for the research. Reference
EffectEvidenceSynthesis exposure A reference to a EvidenceVariable resource that defines the exposure for the research. Reference
EffectEvidenceSynthesis exposureAlternative A reference to a EvidenceVariable resource that defines the comparison exposure for the research. Reference
EffectEvidenceSynthesis outcome A reference to a EvidenceVariable resomece that defines the outcome for the research. Reference
EffectEvidenceSynthesis sampleSize A description of the size of the sample involved in the synthesis. EffectEvidenceSynthesis_SampleSize
EffectEvidenceSynthesis resultsByExposure A description of the results for each exposure considered in the effect estimate. EffectEvidenceSynthesis_ResultsByExposure
EffectEvidenceSynthesis effectEstimate The estimated effect of the exposure variant. EffectEvidenceSynthesis_EffectEstimate
EffectEvidenceSynthesis certainty A description of the certainty of the effect estimate. EffectEvidenceSynthesis_Certainty
EffectEvidenceSynthesis_Certainty id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EffectEvidenceSynthesis_Certainty extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EffectEvidenceSynthesis_Certainty modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EffectEvidenceSynthesis_Certainty rating A rating of the certainty of the effect estimate. CodeableConcept
EffectEvidenceSynthesis_Certainty note A human-readable string to clarify or explain concepts about the resource. Annotation
EffectEvidenceSynthesis_Certainty certaintySubcomponent A description of a component of the overall certainty. EffectEvidenceSynthesis_CertaintySubcomponent
EffectEvidenceSynthesis_CertaintySubcomponent id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EffectEvidenceSynthesis_CertaintySubcomponent extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EffectEvidenceSynthesis_CertaintySubcomponent modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EffectEvidenceSynthesis_CertaintySubcomponent type Type of subcomponent of certainty rating. CodeableConcept
EffectEvidenceSynthesis_CertaintySubcomponent rating A rating of a subcomponent of rating certainty. CodeableConcept
EffectEvidenceSynthesis_CertaintySubcomponent note A human-readable string to clarify or explain concepts about the resource. Annotation
EffectEvidenceSynthesis_EffectEstimate id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EffectEvidenceSynthesis_EffectEstimate extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EffectEvidenceSynthesis_EffectEstimate modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EffectEvidenceSynthesis_EffectEstimate description Human-readable summary of effect estimate. string
EffectEvidenceSynthesis_EffectEstimate _description Extensions for description Element
EffectEvidenceSynthesis_EffectEstimate type Examples include relative risk and mean difference. CodeableConcept
EffectEvidenceSynthesis_EffectEstimate variantState Used to define variant exposure states such as low-risk state. CodeableConcept
EffectEvidenceSynthesis_EffectEstimate value The point estimate of the effect estimate. decimal
EffectEvidenceSynthesis_EffectEstimate _value Extensions for value Element
EffectEvidenceSynthesis_EffectEstimate unitOfMeasure Specifies the UCUM unit for the outcome. CodeableConcept
EffectEvidenceSynthesis_EffectEstimate precisionEstimate A description of the precision of the estimate for the effect. EffectEvidenceSynthesis_PrecisionEstimate
EffectEvidenceSynthesis_PrecisionEstimate id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EffectEvidenceSynthesis_PrecisionEstimate extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EffectEvidenceSynthesis_PrecisionEstimate modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EffectEvidenceSynthesis_PrecisionEstimate type Examples include confidence interval and interquartile range. CodeableConcept
EffectEvidenceSynthesis_PrecisionEstimate level Use 95 for a 95% confidence interval. decimal
EffectEvidenceSynthesis_PrecisionEstimate _level Extensions for level Element
EffectEvidenceSynthesis_PrecisionEstimate from Lower bound of confidence interval. decimal
EffectEvidenceSynthesis_PrecisionEstimate _from Extensions for from Element
EffectEvidenceSynthesis_PrecisionEstimate to Upper bound of confidence interval. decimal
EffectEvidenceSynthesis_PrecisionEstimate _to Extensions for to Element
EffectEvidenceSynthesis_ResultsByExposure id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EffectEvidenceSynthesis_ResultsByExposure extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EffectEvidenceSynthesis_ResultsByExposure modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EffectEvidenceSynthesis_ResultsByExposure description Human-readable summary of results by exposure state. string
EffectEvidenceSynthesis_ResultsByExposure _description Extensions for description Element
EffectEvidenceSynthesis_ResultsByExposure exposureState Whether these results are for the exposure state or alternative exposure state. enum values:
exposure
exposure-alternative
EffectEvidenceSynthesis_ResultsByExposure _exposureState Extensions for exposureState Element
EffectEvidenceSynthesis_ResultsByExposure variantState Used to define variant exposure states such as low-risk state. CodeableConcept
EffectEvidenceSynthesis_ResultsByExposure riskEvidenceSynthesis Reference to a RiskEvidenceSynthesis resource. Reference
EffectEvidenceSynthesis_SampleSize id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EffectEvidenceSynthesis_SampleSize extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EffectEvidenceSynthesis_SampleSize modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EffectEvidenceSynthesis_SampleSize description Human-readable summary of sample size. string
EffectEvidenceSynthesis_SampleSize _description Extensions for description Element
EffectEvidenceSynthesis_SampleSize numberOfStudies Number of studies included in this evidence synthesis. integer
EffectEvidenceSynthesis_SampleSize _numberOfStudies Extensions for numberOfStudies Element
EffectEvidenceSynthesis_SampleSize numberOfParticipants Number of participants included in this evidence synthesis. integer
EffectEvidenceSynthesis_SampleSize _numberOfParticipants Extensions for numberOfParticipants Element
Element id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Element extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition path The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension. string
ElementDefinition _path Extensions for path Element
ElementDefinition representation Codes that define how this element is represented in instances, when the deviation varies from the normal case. enum values:
xmlAttr
xmlText
typeAttr
cdaText
xhtml
ElementDefinition _representation Extensions for representation Element
ElementDefinition sliceName 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. string
ElementDefinition _sliceName Extensions for sliceName Element
ElementDefinition sliceIsConstraining 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. boolean
ElementDefinition _sliceIsConstraining Extensions for sliceIsConstraining Element
ElementDefinition label 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. string
ElementDefinition _label Extensions for label Element
ElementDefinition code A code that has the same meaning as the element in a particular terminology. Coding
ElementDefinition slicing 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). ElementDefinition_Slicing
ElementDefinition short A concise description of what this element means (e.g. for use in autogenerated summaries). string
ElementDefinition _short Extensions for short Element
ElementDefinition definition 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). markdown
ElementDefinition _definition Extensions for definition Element
ElementDefinition comment 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). markdown
ElementDefinition _comment Extensions for comment Element
ElementDefinition requirements 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. markdown
ElementDefinition _requirements Extensions for requirements Element
ElementDefinition alias Identifies additional names by which this element might also be known. string
ElementDefinition _alias Extensions for alias Element
ElementDefinition min The minimum number of times this element SHALL appear in the instance. unsignedInt
ElementDefinition _min Extensions for min Element
ElementDefinition max The maximum number of times this element is permitted to appear in the instance. string
ElementDefinition _max Extensions for max Element
ElementDefinition base Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same. ElementDefinition_Base
ElementDefinition contentReference 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. uri
ElementDefinition _contentReference Extensions for contentReference Element
ElementDefinition type The data type or resource that the value of this element is permitted to be. ElementDefinition_Type
ElementDefinition defaultValueBase64Binary 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'). notDefined
ElementDefinition _defaultValueBase64Binary Extensions for defaultValueBase64Binary Element
ElementDefinition defaultValueBoolean 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'). notDefined
ElementDefinition _defaultValueBoolean Extensions for defaultValueBoolean Element
ElementDefinition defaultValueCanonical 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'). notDefined
ElementDefinition _defaultValueCanonical Extensions for defaultValueCanonical Element
ElementDefinition defaultValueCode 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'). notDefined
ElementDefinition _defaultValueCode Extensions for defaultValueCode Element
ElementDefinition defaultValueDate 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'). notDefined
ElementDefinition _defaultValueDate Extensions for defaultValueDate Element
ElementDefinition defaultValueDateTime 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'). notDefined
ElementDefinition _defaultValueDateTime Extensions for defaultValueDateTime Element
ElementDefinition defaultValueDecimal 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'). notDefined
ElementDefinition _defaultValueDecimal Extensions for defaultValueDecimal Element
ElementDefinition defaultValueId 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'). notDefined
ElementDefinition _defaultValueId Extensions for defaultValueId Element
ElementDefinition defaultValueInstant 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'). notDefined
ElementDefinition _defaultValueInstant Extensions for defaultValueInstant Element
ElementDefinition defaultValueInteger 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'). notDefined
ElementDefinition _defaultValueInteger Extensions for defaultValueInteger Element
ElementDefinition defaultValueMarkdown 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'). notDefined
ElementDefinition _defaultValueMarkdown Extensions for defaultValueMarkdown Element
ElementDefinition defaultValueOid 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'). notDefined
ElementDefinition _defaultValueOid Extensions for defaultValueOid Element
ElementDefinition defaultValuePositiveInt 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'). notDefined
ElementDefinition _defaultValuePositiveInt Extensions for defaultValuePositiveInt Element
ElementDefinition defaultValueString 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'). notDefined
ElementDefinition _defaultValueString Extensions for defaultValueString Element
ElementDefinition defaultValueTime 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'). notDefined
ElementDefinition _defaultValueTime Extensions for defaultValueTime Element
ElementDefinition defaultValueUnsignedInt 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'). notDefined
ElementDefinition _defaultValueUnsignedInt Extensions for defaultValueUnsignedInt Element
ElementDefinition defaultValueUri 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'). notDefined
ElementDefinition _defaultValueUri Extensions for defaultValueUri Element
ElementDefinition defaultValueUrl 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'). notDefined
ElementDefinition _defaultValueUrl Extensions for defaultValueUrl Element
ElementDefinition defaultValueUuid 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'). notDefined
ElementDefinition _defaultValueUuid Extensions for defaultValueUuid Element
ElementDefinition defaultValueAddress 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'). Address
ElementDefinition defaultValueAge 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'). Age
ElementDefinition defaultValueAnnotation 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'). Annotation
ElementDefinition defaultValueAttachment 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'). Attachment
ElementDefinition defaultValueCodeableConcept 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'). CodeableConcept
ElementDefinition defaultValueCoding 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'). Coding
ElementDefinition defaultValueContactPoint 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'). ContactPoint
ElementDefinition defaultValueCount 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'). Count
ElementDefinition defaultValueDistance 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'). Distance
ElementDefinition defaultValueDuration 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'). Duration
ElementDefinition defaultValueHumanName 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'). HumanName
ElementDefinition defaultValueIdentifier 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'). Identifier
ElementDefinition defaultValueMoney 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'). Money
ElementDefinition defaultValuePeriod 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'). Period
ElementDefinition defaultValueQuantity 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'). Quantity
ElementDefinition defaultValueRange 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'). Range
ElementDefinition defaultValueRatio 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'). Ratio
ElementDefinition defaultValueReference 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'). Reference
ElementDefinition defaultValueSampledData 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'). SampledData
ElementDefinition defaultValueSignature 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'). Signature
ElementDefinition defaultValueTiming 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'). Timing
ElementDefinition defaultValueContactDetail 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'). ContactDetail
ElementDefinition defaultValueContributor 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'). Contributor
ElementDefinition defaultValueDataRequirement 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'). DataRequirement
ElementDefinition defaultValueExpression 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'). Expression
ElementDefinition defaultValueParameterDefinition 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'). ParameterDefinition
ElementDefinition defaultValueRelatedArtifact 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'). RelatedArtifact
ElementDefinition defaultValueTriggerDefinition 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'). TriggerDefinition
ElementDefinition defaultValueUsageContext 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'). UsageContext
ElementDefinition defaultValueDosage 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'). Dosage
ElementDefinition meaningWhenMissing The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'). markdown
ElementDefinition _meaningWhenMissing Extensions for meaningWhenMissing Element
ElementDefinition orderMeaning 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. string
ElementDefinition _orderMeaning Extensions for orderMeaning Element
ElementDefinition fixedBase64Binary Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedBase64Binary Extensions for fixedBase64Binary Element
ElementDefinition fixedBoolean Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedBoolean Extensions for fixedBoolean Element
ElementDefinition fixedCanonical Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedCanonical Extensions for fixedCanonical Element
ElementDefinition fixedCode Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedCode Extensions for fixedCode Element
ElementDefinition fixedDate Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedDate Extensions for fixedDate Element
ElementDefinition fixedDateTime Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedDateTime Extensions for fixedDateTime Element
ElementDefinition fixedDecimal Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedDecimal Extensions for fixedDecimal Element
ElementDefinition fixedId Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedId Extensions for fixedId Element
ElementDefinition fixedInstant Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedInstant Extensions for fixedInstant Element
ElementDefinition fixedInteger Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedInteger Extensions for fixedInteger Element
ElementDefinition fixedMarkdown Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedMarkdown Extensions for fixedMarkdown Element
ElementDefinition fixedOid Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedOid Extensions for fixedOid Element
ElementDefinition fixedPositiveInt Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedPositiveInt Extensions for fixedPositiveInt Element
ElementDefinition fixedString Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedString Extensions for fixedString Element
ElementDefinition fixedTime Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedTime Extensions for fixedTime Element
ElementDefinition fixedUnsignedInt Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedUnsignedInt Extensions for fixedUnsignedInt Element
ElementDefinition fixedUri Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedUri Extensions for fixedUri Element
ElementDefinition fixedUrl Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedUrl Extensions for fixedUrl Element
ElementDefinition fixedUuid Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. notDefined
ElementDefinition _fixedUuid Extensions for fixedUuid Element
ElementDefinition fixedAddress Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Address
ElementDefinition fixedAge Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Age
ElementDefinition fixedAnnotation Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Annotation
ElementDefinition fixedAttachment Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Attachment
ElementDefinition fixedCodeableConcept Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. CodeableConcept
ElementDefinition fixedCoding Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Coding
ElementDefinition fixedContactPoint Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. ContactPoint
ElementDefinition fixedCount Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Count
ElementDefinition fixedDistance Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Distance
ElementDefinition fixedDuration Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Duration
ElementDefinition fixedHumanName Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. HumanName
ElementDefinition fixedIdentifier Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Identifier
ElementDefinition fixedMoney Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Money
ElementDefinition fixedPeriod Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Period
ElementDefinition fixedQuantity Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Quantity
ElementDefinition fixedRange Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Range
ElementDefinition fixedRatio Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Ratio
ElementDefinition fixedReference Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Reference
ElementDefinition fixedSampledData Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. SampledData
ElementDefinition fixedSignature Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Signature
ElementDefinition fixedTiming Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Timing
ElementDefinition fixedContactDetail Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. ContactDetail
ElementDefinition fixedContributor Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Contributor
ElementDefinition fixedDataRequirement Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. DataRequirement
ElementDefinition fixedExpression Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Expression
ElementDefinition fixedParameterDefinition Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. ParameterDefinition
ElementDefinition fixedRelatedArtifact Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. RelatedArtifact
ElementDefinition fixedTriggerDefinition Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. TriggerDefinition
ElementDefinition fixedUsageContext Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. UsageContext
ElementDefinition fixedDosage Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Dosage
ElementDefinition patternBase64Binary Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternBase64Binary Extensions for patternBase64Binary Element
ElementDefinition patternBoolean Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternBoolean Extensions for patternBoolean Element
ElementDefinition patternCanonical Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternCanonical Extensions for patternCanonical Element
ElementDefinition patternCode Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternCode Extensions for patternCode Element
ElementDefinition patternDate Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternDate Extensions for patternDate Element
ElementDefinition patternDateTime Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternDateTime Extensions for patternDateTime Element
ElementDefinition patternDecimal Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternDecimal Extensions for patternDecimal Element
ElementDefinition patternId Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternId Extensions for patternId Element
ElementDefinition patternInstant Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternInstant Extensions for patternInstant Element
ElementDefinition patternInteger Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternInteger Extensions for patternInteger Element
ElementDefinition patternMarkdown Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternMarkdown Extensions for patternMarkdown Element
ElementDefinition patternOid Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternOid Extensions for patternOid Element
ElementDefinition patternPositiveInt Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternPositiveInt Extensions for patternPositiveInt Element
ElementDefinition patternString Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternString Extensions for patternString Element
ElementDefinition patternTime Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternTime Extensions for patternTime Element
ElementDefinition patternUnsignedInt Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternUnsignedInt Extensions for patternUnsignedInt Element
ElementDefinition patternUri Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternUri Extensions for patternUri Element
ElementDefinition patternUrl Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternUrl Extensions for patternUrl Element
ElementDefinition patternUuid Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. notDefined
ElementDefinition _patternUuid Extensions for patternUuid Element
ElementDefinition patternAddress Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Address
ElementDefinition patternAge Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Age
ElementDefinition patternAnnotation Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Annotation
ElementDefinition patternAttachment Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Attachment
ElementDefinition patternCodeableConcept Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. CodeableConcept
ElementDefinition patternCoding Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Coding
ElementDefinition patternContactPoint Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. ContactPoint
ElementDefinition patternCount Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Count
ElementDefinition patternDistance Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Distance
ElementDefinition patternDuration Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Duration
ElementDefinition patternHumanName Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. HumanName
ElementDefinition patternIdentifier Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Identifier
ElementDefinition patternMoney Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Money
ElementDefinition patternPeriod Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Period
ElementDefinition patternQuantity Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Quantity
ElementDefinition patternRange Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Range
ElementDefinition patternRatio Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Ratio
ElementDefinition patternReference Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Reference
ElementDefinition patternSampledData Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. SampledData
ElementDefinition patternSignature Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Signature
ElementDefinition patternTiming Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Timing
ElementDefinition patternContactDetail Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. ContactDetail
ElementDefinition patternContributor Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Contributor
ElementDefinition patternDataRequirement Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. DataRequirement
ElementDefinition patternExpression Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Expression
ElementDefinition patternParameterDefinition Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. ParameterDefinition
ElementDefinition patternRelatedArtifact Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. RelatedArtifact
ElementDefinition patternTriggerDefinition Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. TriggerDefinition
ElementDefinition patternUsageContext Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. UsageContext
ElementDefinition patternDosage Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Dosage
ElementDefinition example A sample value for this element demonstrating the type of information that would typically be found in the element. ElementDefinition_Example
ElementDefinition minValueDate 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. notDefined
ElementDefinition _minValueDate Extensions for minValueDate Element
ElementDefinition minValueDateTime 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. notDefined
ElementDefinition _minValueDateTime Extensions for minValueDateTime Element
ElementDefinition minValueInstant 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. notDefined
ElementDefinition _minValueInstant Extensions for minValueInstant Element
ElementDefinition minValueTime 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. notDefined
ElementDefinition _minValueTime Extensions for minValueTime Element
ElementDefinition minValueDecimal 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. notDefined
ElementDefinition _minValueDecimal Extensions for minValueDecimal Element
ElementDefinition minValueInteger 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. notDefined
ElementDefinition _minValueInteger Extensions for minValueInteger Element
ElementDefinition minValuePositiveInt 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. notDefined
ElementDefinition _minValuePositiveInt Extensions for minValuePositiveInt Element
ElementDefinition minValueUnsignedInt 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. notDefined
ElementDefinition _minValueUnsignedInt Extensions for minValueUnsignedInt Element
ElementDefinition minValueQuantity 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. Quantity
ElementDefinition maxValueDate 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. notDefined
ElementDefinition _maxValueDate Extensions for maxValueDate Element
ElementDefinition maxValueDateTime 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. notDefined
ElementDefinition _maxValueDateTime Extensions for maxValueDateTime Element
ElementDefinition maxValueInstant 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. notDefined
ElementDefinition _maxValueInstant Extensions for maxValueInstant Element
ElementDefinition maxValueTime 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. notDefined
ElementDefinition _maxValueTime Extensions for maxValueTime Element
ElementDefinition maxValueDecimal 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. notDefined
ElementDefinition _maxValueDecimal Extensions for maxValueDecimal Element
ElementDefinition maxValueInteger 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. notDefined
ElementDefinition _maxValueInteger Extensions for maxValueInteger Element
ElementDefinition maxValuePositiveInt 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. notDefined
ElementDefinition _maxValuePositiveInt Extensions for maxValuePositiveInt Element
ElementDefinition maxValueUnsignedInt 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. notDefined
ElementDefinition _maxValueUnsignedInt Extensions for maxValueUnsignedInt Element
ElementDefinition maxValueQuantity 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. Quantity
ElementDefinition maxLength 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. integer
ElementDefinition _maxLength Extensions for maxLength Element
ElementDefinition condition A reference to an invariant that may make additional statements about the cardinality or value in the instance. id
ElementDefinition _condition Extensions for condition Element
ElementDefinition constraint Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance. ElementDefinition_Constraint
ElementDefinition mustSupport If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation. boolean
ElementDefinition _mustSupport Extensions for mustSupport Element
ElementDefinition isModifier 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. boolean
ElementDefinition _isModifier Extensions for isModifier Element
ElementDefinition isModifierReason Explains how that element affects the interpretation of the resource or element that contains it. string
ElementDefinition _isModifierReason Extensions for isModifierReason Element
ElementDefinition isSummary Whether the element should be included if a client requests a search with the parameter _summary=true. boolean
ElementDefinition _isSummary Extensions for isSummary Element
ElementDefinition binding Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri). ElementDefinition_Binding
ElementDefinition mapping Identifies a concept from an external specification that roughly corresponds to this element. ElementDefinition_Mapping
ElementDefinition_Base id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Base extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Base modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Base path The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base. string
ElementDefinition_Base _path Extensions for path Element
ElementDefinition_Base min Minimum cardinality of the base element identified by the path. unsignedInt
ElementDefinition_Base _min Extensions for min Element
ElementDefinition_Base max Maximum cardinality of the base element identified by the path. string
ElementDefinition_Base _max Extensions for max Element
ElementDefinition_Binding id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Binding extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Binding modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Binding strength 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. enum values:
required
extensible
preferred
example
ElementDefinition_Binding _strength Extensions for strength Element
ElementDefinition_Binding description Describes the intended use of this particular set of codes. string
ElementDefinition_Binding _description Extensions for description Element
ElementDefinition_Binding valueSet Refers to the value set that identifies the set of codes the binding refers to. canonical
ElementDefinition_Constraint id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Constraint extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Constraint modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Constraint key Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality. id
ElementDefinition_Constraint _key Extensions for key Element
ElementDefinition_Constraint requirements Description of why this constraint is necessary or appropriate. string
ElementDefinition_Constraint _requirements Extensions for requirements Element
ElementDefinition_Constraint severity Identifies the impact constraint violation has on the conformance of the instance. enum values:
error
warning
ElementDefinition_Constraint _severity Extensions for severity Element
ElementDefinition_Constraint human Text that can be used to describe the constraint in messages identifying that the constraint has been violated. string
ElementDefinition_Constraint _human Extensions for human Element
ElementDefinition_Constraint expression A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met. string
ElementDefinition_Constraint _expression Extensions for expression Element
ElementDefinition_Constraint xpath An XPath expression of constraint that can be executed to see if this constraint is met. string
ElementDefinition_Constraint _xpath Extensions for xpath Element
ElementDefinition_Constraint source A reference to the original source of the constraint, for traceability purposes. canonical
ElementDefinition_Discriminator id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Discriminator extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Discriminator modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Discriminator type How the element value is interpreted when discrimination is evaluated. enum values:
value
exists
pattern
type
profile
ElementDefinition_Discriminator _type Extensions for type Element
ElementDefinition_Discriminator path A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based. string
ElementDefinition_Discriminator _path Extensions for path Element
ElementDefinition_Example id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Example extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Example modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Example label Describes the purpose of this example amoung the set of examples. string
ElementDefinition_Example _label Extensions for label Element
ElementDefinition_Example valueBase64Binary The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueBase64Binary Extensions for valueBase64Binary Element
ElementDefinition_Example valueBoolean The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueBoolean Extensions for valueBoolean Element
ElementDefinition_Example valueCanonical The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueCanonical Extensions for valueCanonical Element
ElementDefinition_Example valueCode The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueCode Extensions for valueCode Element
ElementDefinition_Example valueDate The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueDate Extensions for valueDate Element
ElementDefinition_Example valueDateTime The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueDateTime Extensions for valueDateTime Element
ElementDefinition_Example valueDecimal The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueDecimal Extensions for valueDecimal Element
ElementDefinition_Example valueId The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueId Extensions for valueId Element
ElementDefinition_Example valueInstant The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueInstant Extensions for valueInstant Element
ElementDefinition_Example valueInteger The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueInteger Extensions for valueInteger Element
ElementDefinition_Example valueMarkdown The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueMarkdown Extensions for valueMarkdown Element
ElementDefinition_Example valueOid The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueOid Extensions for valueOid Element
ElementDefinition_Example valuePositiveInt The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valuePositiveInt Extensions for valuePositiveInt Element
ElementDefinition_Example valueString The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueString Extensions for valueString Element
ElementDefinition_Example valueTime The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueTime Extensions for valueTime Element
ElementDefinition_Example valueUnsignedInt The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueUnsignedInt Extensions for valueUnsignedInt Element
ElementDefinition_Example valueUri The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueUri Extensions for valueUri Element
ElementDefinition_Example valueUrl The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueUrl Extensions for valueUrl Element
ElementDefinition_Example valueUuid The actual value for the element, which must be one of the types allowed for this element. notDefined
ElementDefinition_Example _valueUuid Extensions for valueUuid Element
ElementDefinition_Example valueAddress The actual value for the element, which must be one of the types allowed for this element. Address
ElementDefinition_Example valueAge The actual value for the element, which must be one of the types allowed for this element. Age
ElementDefinition_Example valueAnnotation The actual value for the element, which must be one of the types allowed for this element. Annotation
ElementDefinition_Example valueAttachment The actual value for the element, which must be one of the types allowed for this element. Attachment
ElementDefinition_Example valueCodeableConcept The actual value for the element, which must be one of the types allowed for this element. CodeableConcept
ElementDefinition_Example valueCoding The actual value for the element, which must be one of the types allowed for this element. Coding
ElementDefinition_Example valueContactPoint The actual value for the element, which must be one of the types allowed for this element. ContactPoint
ElementDefinition_Example valueCount The actual value for the element, which must be one of the types allowed for this element. Count
ElementDefinition_Example valueDistance The actual value for the element, which must be one of the types allowed for this element. Distance
ElementDefinition_Example valueDuration The actual value for the element, which must be one of the types allowed for this element. Duration
ElementDefinition_Example valueHumanName The actual value for the element, which must be one of the types allowed for this element. HumanName
ElementDefinition_Example valueIdentifier The actual value for the element, which must be one of the types allowed for this element. Identifier
ElementDefinition_Example valueMoney The actual value for the element, which must be one of the types allowed for this element. Money
ElementDefinition_Example valuePeriod The actual value for the element, which must be one of the types allowed for this element. Period
ElementDefinition_Example valueQuantity The actual value for the element, which must be one of the types allowed for this element. Quantity
ElementDefinition_Example valueRange The actual value for the element, which must be one of the types allowed for this element. Range
ElementDefinition_Example valueRatio The actual value for the element, which must be one of the types allowed for this element. Ratio
ElementDefinition_Example valueReference The actual value for the element, which must be one of the types allowed for this element. Reference
ElementDefinition_Example valueSampledData The actual value for the element, which must be one of the types allowed for this element. SampledData
ElementDefinition_Example valueSignature The actual value for the element, which must be one of the types allowed for this element. Signature
ElementDefinition_Example valueTiming The actual value for the element, which must be one of the types allowed for this element. Timing
ElementDefinition_Example valueContactDetail The actual value for the element, which must be one of the types allowed for this element. ContactDetail
ElementDefinition_Example valueContributor The actual value for the element, which must be one of the types allowed for this element. Contributor
ElementDefinition_Example valueDataRequirement The actual value for the element, which must be one of the types allowed for this element. DataRequirement
ElementDefinition_Example valueExpression The actual value for the element, which must be one of the types allowed for this element. Expression
ElementDefinition_Example valueParameterDefinition The actual value for the element, which must be one of the types allowed for this element. ParameterDefinition
ElementDefinition_Example valueRelatedArtifact The actual value for the element, which must be one of the types allowed for this element. RelatedArtifact
ElementDefinition_Example valueTriggerDefinition The actual value for the element, which must be one of the types allowed for this element. TriggerDefinition
ElementDefinition_Example valueUsageContext The actual value for the element, which must be one of the types allowed for this element. UsageContext
ElementDefinition_Example valueDosage The actual value for the element, which must be one of the types allowed for this element. Dosage
ElementDefinition_Mapping id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Mapping extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Mapping modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Mapping identity An internal reference to the definition of a mapping. id
ElementDefinition_Mapping _identity Extensions for identity Element
ElementDefinition_Mapping language Identifies the computable language in which mapping.map is expressed. code
ElementDefinition_Mapping _language Extensions for language Element
ElementDefinition_Mapping map Expresses what part of the target specification corresponds to this element. string
ElementDefinition_Mapping _map Extensions for map Element
ElementDefinition_Mapping comment Comments that provide information about the mapping or its use. string
ElementDefinition_Mapping _comment Extensions for comment Element
ElementDefinition_Slicing id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Slicing extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Slicing modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Slicing discriminator 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. ElementDefinition_Discriminator
ElementDefinition_Slicing description 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. string
ElementDefinition_Slicing _description Extensions for description Element
ElementDefinition_Slicing ordered If the matching elements have to occur in the same order as defined in the profile. boolean
ElementDefinition_Slicing _ordered Extensions for ordered Element
ElementDefinition_Slicing rules 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. enum values:
closed
open
openAtEnd
ElementDefinition_Slicing _rules Extensions for rules Element
ElementDefinition_Type id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ElementDefinition_Type extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ElementDefinition_Type modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ElementDefinition_Type code 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. uri
ElementDefinition_Type _code Extensions for code Element
ElementDefinition_Type profile 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. canonical
ElementDefinition_Type targetProfile 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. canonical
ElementDefinition_Type aggregation 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. enum values:
contained
referenced
bundled
ElementDefinition_Type _aggregation Extensions for aggregation Element
ElementDefinition_Type versioning Whether this reference needs to be version specific or version independent, or whether either can be used. enum values:
either
independent
specific
ElementDefinition_Type _versioning Extensions for versioning Element
Encounter resourceType This is a Encounter resource Encounter
Encounter id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Encounter meta 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. Meta
Encounter implicitRules 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. uri
Encounter _implicitRules Extensions for implicitRules Element
Encounter language The base language in which the resource is written. code
Encounter _language Extensions for language Element
Encounter text 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. Narrative
Encounter contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Encounter extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Encounter modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Encounter identifier Identifier(s) by which this encounter is known. Identifier
Encounter status planned | arrived | triaged | in-progress | onleave | finished | cancelled +. enum values:
planned
arrived
triaged
in-progress
onleave
finished
cancelled
entered-in-error
unknown
Encounter _status Extensions for status Element
Encounter statusHistory The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. Encounter_StatusHistory
Encounter class Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. Coding
Encounter classHistory The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient. Encounter_ClassHistory
Encounter type Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). CodeableConcept
Encounter serviceType Broad categorization of the service that is to be provided (e.g. cardiology). CodeableConcept
Encounter priority Indicates the urgency of the encounter. CodeableConcept
Encounter subject The patient or group present at the encounter. Reference
Encounter episodeOfCare 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). Reference
Encounter basedOn The request this encounter satisfies (e.g. incoming referral or procedure request). Reference
Encounter participant The list of people responsible for providing the service. Encounter_Participant
Encounter appointment The appointment that scheduled this encounter. Reference
Encounter period The start and end time of the encounter. Period
Encounter length Quantity of time the encounter lasted. This excludes the time during leaves of absence. Duration
Encounter reasonCode Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. CodeableConcept
Encounter reasonReference Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. Reference
Encounter diagnosis The list of diagnosis relevant to this encounter. Encounter_Diagnosis
Encounter account The set of accounts that may be used for billing for this Encounter. Reference
Encounter hospitalization Details about the admission to a healthcare service. Encounter_Hospitalization
Encounter location List of locations where the patient has been during this encounter. Encounter_Location
Encounter serviceProvider 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 example bundle showing an abbreviated set of Encounters for a colonoscopy. Reference
Encounter partOf Another Encounter of which this encounter is a part of (administratively or in time). Reference
Encounter_ClassHistory id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Encounter_ClassHistory extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Encounter_ClassHistory modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Encounter_ClassHistory class inpatient | outpatient | ambulatory | emergency +. Coding
Encounter_ClassHistory period The time that the episode was in the specified class. Period
Encounter_Diagnosis id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Encounter_Diagnosis extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Encounter_Diagnosis modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Encounter_Diagnosis condition Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. Reference
Encounter_Diagnosis use Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …). CodeableConcept
Encounter_Diagnosis rank Ranking of the diagnosis (for each role type). positiveInt
Encounter_Diagnosis _rank Extensions for rank Element
Encounter_Hospitalization id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Encounter_Hospitalization extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Encounter_Hospitalization modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Encounter_Hospitalization preAdmissionIdentifier Pre-admission identifier. Identifier
Encounter_Hospitalization origin The location/organization from which the patient came before admission. Reference
Encounter_Hospitalization admitSource From where patient was admitted (physician referral, transfer). CodeableConcept
Encounter_Hospitalization reAdmission Whether this hospitalization is a readmission and why if known. CodeableConcept
Encounter_Hospitalization dietPreference Diet preferences reported by the patient. CodeableConcept
Encounter_Hospitalization specialCourtesy Special courtesies (VIP, board member). CodeableConcept
Encounter_Hospitalization specialArrangement Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things. CodeableConcept
Encounter_Hospitalization destination Location/organization to which the patient is discharged. Reference
Encounter_Hospitalization dischargeDisposition Category or kind of location after discharge. CodeableConcept
Encounter_Location id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Encounter_Location extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Encounter_Location modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Encounter_Location location The location where the encounter takes place. Reference
Encounter_Location status 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. enum values:
planned
active
reserved
completed
Encounter_Location _status Extensions for status Element
Encounter_Location physicalType This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. CodeableConcept
Encounter_Location period Time period during which the patient was present at the location. Period
Encounter_Participant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Encounter_Participant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Encounter_Participant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Encounter_Participant type Role of participant in encounter. CodeableConcept
Encounter_Participant period 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. Period
Encounter_Participant individual Persons involved in the encounter other than the patient. Reference
Encounter_StatusHistory id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Encounter_StatusHistory extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Encounter_StatusHistory modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Encounter_StatusHistory status planned | arrived | triaged | in-progress | onleave | finished | cancelled +. enum values:
planned
arrived
triaged
in-progress
onleave
finished
cancelled
entered-in-error
unknown
Encounter_StatusHistory _status Extensions for status Element
Encounter_StatusHistory period The time that the episode was in the specified status. Period
Endpoint resourceType This is a Endpoint resource Endpoint
Endpoint id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Endpoint meta 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. Meta
Endpoint implicitRules 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. uri
Endpoint _implicitRules Extensions for implicitRules Element
Endpoint language The base language in which the resource is written. code
Endpoint _language Extensions for language Element
Endpoint text 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. Narrative
Endpoint contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Endpoint extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Endpoint modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Endpoint identifier Identifier for the organization that is used to identify the endpoint across multiple disparate systems. Identifier
Endpoint status active | suspended | error | off | test. enum values:
active
suspended
error
off
entered-in-error
test
Endpoint _status Extensions for status Element
Endpoint connectionType 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). Coding
Endpoint name A friendly name that this endpoint can be referred to with. string
Endpoint _name Extensions for name Element
Endpoint managingOrganization 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). Reference
Endpoint contact Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. ContactPoint
Endpoint period The interval during which the endpoint is expected to be operational. Period
Endpoint payloadType The payload type describes the acceptable content that can be communicated on the endpoint. CodeableConcept
Endpoint payloadMimeType 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). code
Endpoint _payloadMimeType Extensions for payloadMimeType Element
Endpoint address The uri that describes the actual end-point to connect to. url
Endpoint _address Extensions for address Element
Endpoint header Additional headers / information to send as part of the notification. string
Endpoint _header Extensions for header Element
EnrollmentRequest resourceType This is a EnrollmentRequest resource EnrollmentRequest
EnrollmentRequest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
EnrollmentRequest meta 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. Meta
EnrollmentRequest implicitRules 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. uri
EnrollmentRequest _implicitRules Extensions for implicitRules Element
EnrollmentRequest language The base language in which the resource is written. code
EnrollmentRequest _language Extensions for language Element
EnrollmentRequest text 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. Narrative
EnrollmentRequest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
EnrollmentRequest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EnrollmentRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EnrollmentRequest identifier The Response business identifier. Identifier
EnrollmentRequest status The status of the resource instance. code
EnrollmentRequest _status Extensions for status Element
EnrollmentRequest created The date when this resource was created. dateTime
EnrollmentRequest _created Extensions for created Element
EnrollmentRequest insurer The Insurer who is target of the request. Reference
EnrollmentRequest provider The practitioner who is responsible for the services rendered to the patient. Reference
EnrollmentRequest candidate Patient Resource. Reference
EnrollmentRequest coverage Reference to the program or plan identification, underwriter or payor. Reference
EnrollmentResponse resourceType This is a EnrollmentResponse resource EnrollmentResponse
EnrollmentResponse id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
EnrollmentResponse meta 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. Meta
EnrollmentResponse implicitRules 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. uri
EnrollmentResponse _implicitRules Extensions for implicitRules Element
EnrollmentResponse language The base language in which the resource is written. code
EnrollmentResponse _language Extensions for language Element
EnrollmentResponse text 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. Narrative
EnrollmentResponse contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
EnrollmentResponse extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EnrollmentResponse modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EnrollmentResponse identifier The Response business identifier. Identifier
EnrollmentResponse status The status of the resource instance. code
EnrollmentResponse _status Extensions for status Element
EnrollmentResponse request Original request resource reference. Reference
EnrollmentResponse outcome Processing status: error, complete. enum values:
queued
complete
error
partial
EnrollmentResponse _outcome Extensions for outcome Element
EnrollmentResponse disposition A description of the status of the adjudication. string
EnrollmentResponse _disposition Extensions for disposition Element
EnrollmentResponse created The date when the enclosed suite of services were performed or completed. dateTime
EnrollmentResponse _created Extensions for created Element
EnrollmentResponse organization The Insurer who produced this adjudicated response. Reference
EnrollmentResponse requestProvider The practitioner who is responsible for the services rendered to the patient. Reference
EpisodeOfCare resourceType This is a EpisodeOfCare resource EpisodeOfCare
EpisodeOfCare id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
EpisodeOfCare meta 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. Meta
EpisodeOfCare implicitRules 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. uri
EpisodeOfCare _implicitRules Extensions for implicitRules Element
EpisodeOfCare language The base language in which the resource is written. code
EpisodeOfCare _language Extensions for language Element
EpisodeOfCare text 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. Narrative
EpisodeOfCare contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
EpisodeOfCare extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EpisodeOfCare modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EpisodeOfCare identifier 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. Identifier
EpisodeOfCare status planned | waitlist | active | onhold | finished | cancelled. enum values:
planned
waitlist
active
onhold
finished
cancelled
entered-in-error
EpisodeOfCare _status Extensions for status Element
EpisodeOfCare statusHistory The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource). EpisodeOfCare_StatusHistory
EpisodeOfCare type A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care. CodeableConcept
EpisodeOfCare diagnosis The list of diagnosis relevant to this episode of care. EpisodeOfCare_Diagnosis
EpisodeOfCare patient The patient who is the focus of this episode of care. Reference
EpisodeOfCare managingOrganization The organization that has assumed the specific responsibilities for the specified duration. Reference
EpisodeOfCare period The interval during which the managing organization assumes the defined responsibility. Period
EpisodeOfCare referralRequest Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals. Reference
EpisodeOfCare careManager The practitioner that is the care manager/care coordinator for this patient. Reference
EpisodeOfCare team The list of practitioners that may be facilitating this episode of care for specific purposes. Reference
EpisodeOfCare account The set of accounts that may be used for billing for this EpisodeOfCare. Reference
EpisodeOfCare_Diagnosis id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EpisodeOfCare_Diagnosis extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EpisodeOfCare_Diagnosis modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EpisodeOfCare_Diagnosis condition A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for. Reference
EpisodeOfCare_Diagnosis role Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …). CodeableConcept
EpisodeOfCare_Diagnosis rank Ranking of the diagnosis (for each role type). positiveInt
EpisodeOfCare_Diagnosis _rank Extensions for rank Element
EpisodeOfCare_StatusHistory id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EpisodeOfCare_StatusHistory extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EpisodeOfCare_StatusHistory modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EpisodeOfCare_StatusHistory status planned | waitlist | active | onhold | finished | cancelled. enum values:
planned
waitlist
active
onhold
finished
cancelled
entered-in-error
EpisodeOfCare_StatusHistory _status Extensions for status Element
EpisodeOfCare_StatusHistory period The period during this EpisodeOfCare that the specific status applied. Period
EventDefinition resourceType This is a EventDefinition resource EventDefinition
EventDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
EventDefinition meta 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. Meta
EventDefinition implicitRules 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. uri
EventDefinition _implicitRules Extensions for implicitRules Element
EventDefinition language The base language in which the resource is written. code
EventDefinition _language Extensions for language Element
EventDefinition text 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. Narrative
EventDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
EventDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EventDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EventDefinition url 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 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. uri
EventDefinition _url Extensions for url Element
EventDefinition identifier 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. Identifier
EventDefinition version 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. string
EventDefinition _version Extensions for version Element
EventDefinition name 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. string
EventDefinition _name Extensions for name Element
EventDefinition title A short, descriptive, user-friendly title for the event definition. string
EventDefinition _title Extensions for title Element
EventDefinition subtitle An explanatory or alternate title for the event definition giving additional information about its content. string
EventDefinition _subtitle Extensions for subtitle Element
EventDefinition status The status of this event definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
EventDefinition _status Extensions for status Element
EventDefinition experimental 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. boolean
EventDefinition _experimental Extensions for experimental Element
EventDefinition subjectCodeableConcept A code or group definition that describes the intended subject of the event definition. CodeableConcept
EventDefinition subjectReference A code or group definition that describes the intended subject of the event definition. Reference
EventDefinition date The date (and optionally time) when the event definition 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 event definition changes. dateTime
EventDefinition _date Extensions for date Element
EventDefinition publisher The name of the organization or individual that published the event definition. string
EventDefinition _publisher Extensions for publisher Element
EventDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
EventDefinition description A free text natural language description of the event definition from a consumer's perspective. markdown
EventDefinition _description Extensions for description Element
EventDefinition useContext 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. UsageContext
EventDefinition jurisdiction A legal or geographic region in which the event definition is intended to be used. CodeableConcept
EventDefinition purpose Explanation of why this event definition is needed and why it has been designed as it has. markdown
EventDefinition _purpose Extensions for purpose Element
EventDefinition usage A detailed description of how the event definition is used from a clinical perspective. string
EventDefinition _usage Extensions for usage Element
EventDefinition copyright 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. markdown
EventDefinition _copyright Extensions for copyright Element
EventDefinition approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
EventDefinition _approvalDate Extensions for approvalDate Element
EventDefinition lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
EventDefinition _lastReviewDate Extensions for lastReviewDate Element
EventDefinition effectivePeriod The period during which the event definition content was or is planned to be in active use. Period
EventDefinition topic Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching. CodeableConcept
EventDefinition author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
EventDefinition editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
EventDefinition reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
EventDefinition endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
EventDefinition relatedArtifact Related resources such as additional documentation, justification, or bibliographic references. RelatedArtifact
EventDefinition trigger 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. TriggerDefinition
Evidence resourceType This is a Evidence resource Evidence
Evidence id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Evidence meta 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. Meta
Evidence implicitRules 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. uri
Evidence _implicitRules Extensions for implicitRules Element
Evidence language The base language in which the resource is written. code
Evidence _language Extensions for language Element
Evidence text 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. Narrative
Evidence contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Evidence extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Evidence modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Evidence url 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 at which an authoritative instance of this evidence is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence is stored on different servers. uri
Evidence _url Extensions for url Element
Evidence identifier A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance. Identifier
Evidence version The identifier that is used to identify this version of the evidence when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence 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. string
Evidence _version Extensions for version Element
Evidence name 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. string
Evidence _name Extensions for name Element
Evidence title A short, descriptive, user-friendly title for the evidence. string
Evidence _title Extensions for title Element
Evidence shortTitle The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. string
Evidence _shortTitle Extensions for shortTitle Element
Evidence subtitle An explanatory or alternate title for the Evidence giving additional information about its content. string
Evidence _subtitle Extensions for subtitle Element
Evidence status The status of this evidence. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
Evidence _status Extensions for status Element
Evidence date The date (and optionally time) when the evidence 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 evidence changes. dateTime
Evidence _date Extensions for date Element
Evidence publisher The name of the organization or individual that published the evidence. string
Evidence _publisher Extensions for publisher Element
Evidence contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
Evidence description A free text natural language description of the evidence from a consumer's perspective. markdown
Evidence _description Extensions for description Element
Evidence note A human-readable string to clarify or explain concepts about the resource. Annotation
Evidence useContext 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. UsageContext
Evidence jurisdiction A legal or geographic region in which the evidence is intended to be used. CodeableConcept
Evidence copyright 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. markdown
Evidence _copyright Extensions for copyright Element
Evidence approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
Evidence _approvalDate Extensions for approvalDate Element
Evidence lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
Evidence _lastReviewDate Extensions for lastReviewDate Element
Evidence effectivePeriod The period during which the evidence content was or is planned to be in active use. Period
Evidence topic Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching. CodeableConcept
Evidence author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
Evidence editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
Evidence reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
Evidence endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
Evidence relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
Evidence exposureBackground A reference to a EvidenceVariable resource that defines the population for the research. Reference
Evidence exposureVariant A reference to a EvidenceVariable resource that defines the exposure for the research. Reference
Evidence outcome A reference to a EvidenceVariable resomece that defines the outcome for the research. Reference
EvidenceVariable resourceType This is a EvidenceVariable resource EvidenceVariable
EvidenceVariable id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
EvidenceVariable meta 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. Meta
EvidenceVariable implicitRules 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. uri
EvidenceVariable _implicitRules Extensions for implicitRules Element
EvidenceVariable language The base language in which the resource is written. code
EvidenceVariable _language Extensions for language Element
EvidenceVariable text 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. Narrative
EvidenceVariable contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
EvidenceVariable extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EvidenceVariable modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EvidenceVariable url 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 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. uri
EvidenceVariable _url Extensions for url Element
EvidenceVariable identifier 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. Identifier
EvidenceVariable version 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. string
EvidenceVariable _version Extensions for version Element
EvidenceVariable name 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. string
EvidenceVariable _name Extensions for name Element
EvidenceVariable title A short, descriptive, user-friendly title for the evidence variable. string
EvidenceVariable _title Extensions for title Element
EvidenceVariable shortTitle The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. string
EvidenceVariable _shortTitle Extensions for shortTitle Element
EvidenceVariable subtitle An explanatory or alternate title for the EvidenceVariable giving additional information about its content. string
EvidenceVariable _subtitle Extensions for subtitle Element
EvidenceVariable status The status of this evidence variable. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
EvidenceVariable _status Extensions for status Element
EvidenceVariable date The date (and optionally time) when the evidence variable 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 evidence variable changes. dateTime
EvidenceVariable _date Extensions for date Element
EvidenceVariable publisher The name of the organization or individual that published the evidence variable. string
EvidenceVariable _publisher Extensions for publisher Element
EvidenceVariable contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
EvidenceVariable description A free text natural language description of the evidence variable from a consumer's perspective. markdown
EvidenceVariable _description Extensions for description Element
EvidenceVariable note A human-readable string to clarify or explain concepts about the resource. Annotation
EvidenceVariable useContext 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. UsageContext
EvidenceVariable jurisdiction A legal or geographic region in which the evidence variable is intended to be used. CodeableConcept
EvidenceVariable copyright A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable. markdown
EvidenceVariable _copyright Extensions for copyright Element
EvidenceVariable approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
EvidenceVariable _approvalDate Extensions for approvalDate Element
EvidenceVariable lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
EvidenceVariable _lastReviewDate Extensions for lastReviewDate Element
EvidenceVariable effectivePeriod The period during which the evidence variable content was or is planned to be in active use. Period
EvidenceVariable topic Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching. CodeableConcept
EvidenceVariable author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
EvidenceVariable editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
EvidenceVariable reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
EvidenceVariable endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
EvidenceVariable relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
EvidenceVariable type The type of evidence element, a population, an exposure, or an outcome. enum values:
dichotomous
continuous
descriptive
EvidenceVariable _type Extensions for type Element
EvidenceVariable characteristic A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics. EvidenceVariable_Characteristic
EvidenceVariable_Characteristic id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
EvidenceVariable_Characteristic extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
EvidenceVariable_Characteristic modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
EvidenceVariable_Characteristic description A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. string
EvidenceVariable_Characteristic _description Extensions for description Element
EvidenceVariable_Characteristic definitionReference Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). Reference
EvidenceVariable_Characteristic definitionCanonical Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). notDefined
EvidenceVariable_Characteristic _definitionCanonical Extensions for definitionCanonical Element
EvidenceVariable_Characteristic definitionCodeableConcept Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). CodeableConcept
EvidenceVariable_Characteristic definitionExpression Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). Expression
EvidenceVariable_Characteristic definitionDataRequirement Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). DataRequirement
EvidenceVariable_Characteristic definitionTriggerDefinition Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). TriggerDefinition
EvidenceVariable_Characteristic usageContext Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings. UsageContext
EvidenceVariable_Characteristic exclude When true, members with this characteristic are excluded from the element. boolean
EvidenceVariable_Characteristic _exclude Extensions for exclude Element
EvidenceVariable_Characteristic participantEffectiveDateTime Indicates what effective period the study covers. notDefined
EvidenceVariable_Characteristic _participantEffectiveDateTime Extensions for participantEffectiveDateTime Element
EvidenceVariable_Characteristic participantEffectivePeriod Indicates what effective period the study covers. Period
EvidenceVariable_Characteristic participantEffectiveDuration Indicates what effective period the study covers. Duration
EvidenceVariable_Characteristic participantEffectiveTiming Indicates what effective period the study covers. Timing
EvidenceVariable_Characteristic timeFromStart Indicates duration from the participant's study entry. Duration
EvidenceVariable_Characteristic groupMeasure Indicates how elements are aggregated within the study effective period. enum values:
mean
median
mean-of-mean
mean-of-median
median-of-mean
median-of-median
EvidenceVariable_Characteristic _groupMeasure Extensions for groupMeasure Element
ExampleScenario resourceType This is a ExampleScenario resource ExampleScenario
ExampleScenario id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ExampleScenario meta 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. Meta
ExampleScenario implicitRules 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. uri
ExampleScenario _implicitRules Extensions for implicitRules Element
ExampleScenario language The base language in which the resource is written. code
ExampleScenario _language Extensions for language Element
ExampleScenario text 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. Narrative
ExampleScenario contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ExampleScenario extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario url 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 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. uri
ExampleScenario _url Extensions for url Element
ExampleScenario identifier 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. Identifier
ExampleScenario version 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. string
ExampleScenario _version Extensions for version Element
ExampleScenario name A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation. string
ExampleScenario _name Extensions for name Element
ExampleScenario status The status of this example scenario. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
ExampleScenario _status Extensions for status Element
ExampleScenario experimental 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. boolean
ExampleScenario _experimental Extensions for experimental Element
ExampleScenario date The date (and optionally time) when the example scenario 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 example scenario changes. (e.g. the 'content logical definition'). dateTime
ExampleScenario _date Extensions for date Element
ExampleScenario publisher The name of the organization or individual that published the example scenario. string
ExampleScenario _publisher Extensions for publisher Element
ExampleScenario contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ExampleScenario useContext 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. UsageContext
ExampleScenario jurisdiction A legal or geographic region in which the example scenario is intended to be used. CodeableConcept
ExampleScenario copyright 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. markdown
ExampleScenario _copyright Extensions for copyright Element
ExampleScenario purpose 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. markdown
ExampleScenario _purpose Extensions for purpose Element
ExampleScenario actor Actor participating in the resource. ExampleScenario_Actor
ExampleScenario instance Each resource and each version that is present in the workflow. ExampleScenario_Instance
ExampleScenario process Each major process - a group of operations. ExampleScenario_Process
ExampleScenario workflow Another nested workflow. canonical
ExampleScenario_Actor id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_Actor extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_Actor modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_Actor actorId ID or acronym of actor. string
ExampleScenario_Actor _actorId Extensions for actorId Element
ExampleScenario_Actor type The type of actor - person or system. enum values:
person
entity
ExampleScenario_Actor _type Extensions for type Element
ExampleScenario_Actor name The name of the actor as shown in the page. string
ExampleScenario_Actor _name Extensions for name Element
ExampleScenario_Actor description The description of the actor. markdown
ExampleScenario_Actor _description Extensions for description Element
ExampleScenario_Alternative id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_Alternative extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_Alternative modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_Alternative title The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked. string
ExampleScenario_Alternative _title Extensions for title Element
ExampleScenario_Alternative description A human-readable description of the alternative explaining when the alternative should occur rather than the base step. markdown
ExampleScenario_Alternative _description Extensions for description Element
ExampleScenario_Alternative step What happens in each alternative option. ExampleScenario_Step
ExampleScenario_ContainedInstance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_ContainedInstance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_ContainedInstance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_ContainedInstance resourceId Each resource contained in the instance. string
ExampleScenario_ContainedInstance _resourceId Extensions for resourceId Element
ExampleScenario_ContainedInstance versionId A specific version of a resource contained in the instance. string
ExampleScenario_ContainedInstance _versionId Extensions for versionId Element
ExampleScenario_Instance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_Instance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_Instance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_Instance resourceId The id of the resource for referencing. string
ExampleScenario_Instance _resourceId Extensions for resourceId Element
ExampleScenario_Instance resourceType The type of the resource. code
ExampleScenario_Instance _resourceType Extensions for resourceType Element
ExampleScenario_Instance name A short name for the resource instance. string
ExampleScenario_Instance _name Extensions for name Element
ExampleScenario_Instance description Human-friendly description of the resource instance. markdown
ExampleScenario_Instance _description Extensions for description Element
ExampleScenario_Instance version A specific version of the resource. ExampleScenario_Version
ExampleScenario_Instance containedInstance Resources contained in the instance (e.g. the observations contained in a bundle). ExampleScenario_ContainedInstance
ExampleScenario_Operation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_Operation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_Operation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_Operation number The sequential number of the interaction, e.g. 1.2.5. string
ExampleScenario_Operation _number Extensions for number Element
ExampleScenario_Operation type The type of operation - CRUD. string
ExampleScenario_Operation _type Extensions for type Element
ExampleScenario_Operation name The human-friendly name of the interaction. string
ExampleScenario_Operation _name Extensions for name Element
ExampleScenario_Operation initiator Who starts the transaction. string
ExampleScenario_Operation _initiator Extensions for initiator Element
ExampleScenario_Operation receiver Who receives the transaction. string
ExampleScenario_Operation _receiver Extensions for receiver Element
ExampleScenario_Operation description A comment to be inserted in the diagram. markdown
ExampleScenario_Operation _description Extensions for description Element
ExampleScenario_Operation initiatorActive Whether the initiator is deactivated right after the transaction. boolean
ExampleScenario_Operation _initiatorActive Extensions for initiatorActive Element
ExampleScenario_Operation receiverActive Whether the receiver is deactivated right after the transaction. boolean
ExampleScenario_Operation _receiverActive Extensions for receiverActive Element
ExampleScenario_Operation request Each resource instance used by the initiator. ExampleScenario_ContainedInstance
ExampleScenario_Operation response Each resource instance used by the responder. ExampleScenario_ContainedInstance
ExampleScenario_Process id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_Process extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_Process modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_Process title The diagram title of the group of operations. string
ExampleScenario_Process _title Extensions for title Element
ExampleScenario_Process description A longer description of the group of operations. markdown
ExampleScenario_Process _description Extensions for description Element
ExampleScenario_Process preConditions Description of initial status before the process starts. markdown
ExampleScenario_Process _preConditions Extensions for preConditions Element
ExampleScenario_Process postConditions Description of final status after the process ends. markdown
ExampleScenario_Process _postConditions Extensions for postConditions Element
ExampleScenario_Process step Each step of the process. ExampleScenario_Step
ExampleScenario_Step id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_Step extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_Step modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_Step process Nested process. ExampleScenario_Process
ExampleScenario_Step pause If there is a pause in the flow. boolean
ExampleScenario_Step _pause Extensions for pause Element
ExampleScenario_Step operation Each interaction or action. ExampleScenario_Operation
ExampleScenario_Step alternative Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances. ExampleScenario_Alternative
ExampleScenario_Version id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExampleScenario_Version extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExampleScenario_Version modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExampleScenario_Version versionId The identifier of a specific version of a resource. string
ExampleScenario_Version _versionId Extensions for versionId Element
ExampleScenario_Version description The description of the resource version. markdown
ExampleScenario_Version _description Extensions for description Element
ExplanationOfBenefit resourceType This is a ExplanationOfBenefit resource ExplanationOfBenefit
ExplanationOfBenefit id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ExplanationOfBenefit meta 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. Meta
ExplanationOfBenefit implicitRules 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. uri
ExplanationOfBenefit _implicitRules Extensions for implicitRules Element
ExplanationOfBenefit language The base language in which the resource is written. code
ExplanationOfBenefit _language Extensions for language Element
ExplanationOfBenefit text 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. Narrative
ExplanationOfBenefit contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ExplanationOfBenefit extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit identifier A unique identifier assigned to this explanation of benefit. Identifier
ExplanationOfBenefit status The status of the resource instance. enum values:
active
cancelled
draft
entered-in-error
ExplanationOfBenefit _status Extensions for status Element
ExplanationOfBenefit type The category of claim, e.g. oral, pharmacy, vision, institutional, professional. CodeableConcept
ExplanationOfBenefit subType A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service. CodeableConcept
ExplanationOfBenefit use A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future. code
ExplanationOfBenefit _use Extensions for use Element
ExplanationOfBenefit patient 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. Reference
ExplanationOfBenefit billablePeriod The period for which charges are being submitted. Period
ExplanationOfBenefit created The date this resource was created. dateTime
ExplanationOfBenefit _created Extensions for created Element
ExplanationOfBenefit enterer Individual who created the claim, predetermination or preauthorization. Reference
ExplanationOfBenefit insurer The party responsible for authorization, adjudication and reimbursement. Reference
ExplanationOfBenefit provider The provider which is responsible for the claim, predetermination or preauthorization. Reference
ExplanationOfBenefit priority The provider-required urgency of processing the request. Typical values include: stat, routine deferred. CodeableConcept
ExplanationOfBenefit fundsReserveRequested A code to indicate whether and for whom funds are to be reserved for future claims. CodeableConcept
ExplanationOfBenefit fundsReserve A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom. CodeableConcept
ExplanationOfBenefit related Other claims which are related to this claim such as prior submissions or claims for related services or for the same event. ExplanationOfBenefit_Related
ExplanationOfBenefit prescription Prescription to support the dispensing of pharmacy, device or vision products. Reference
ExplanationOfBenefit originalPrescription Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products. Reference
ExplanationOfBenefit payee The party to be reimbursed for cost of the products and services according to the terms of the policy. ExplanationOfBenefit_Payee
ExplanationOfBenefit referral A reference to a referral resource. Reference
ExplanationOfBenefit facility Facility where the services were provided. Reference
ExplanationOfBenefit claim The business identifier for the instance of the adjudication request: claim predetermination or preauthorization. Reference
ExplanationOfBenefit claimResponse The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response. Reference
ExplanationOfBenefit outcome The outcome of the claim, predetermination, or preauthorization processing. code
ExplanationOfBenefit _outcome Extensions for outcome Element
ExplanationOfBenefit disposition A human readable description of the status of the adjudication. string
ExplanationOfBenefit _disposition Extensions for disposition Element
ExplanationOfBenefit preAuthRef Reference from the Insurer which is used in later communications which refers to this adjudication. string
ExplanationOfBenefit _preAuthRef Extensions for preAuthRef Element
ExplanationOfBenefit preAuthRefPeriod The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided. Period
ExplanationOfBenefit careTeam The members of the team who provided the products and services. ExplanationOfBenefit_CareTeam
ExplanationOfBenefit supportingInfo Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. ExplanationOfBenefit_SupportingInfo
ExplanationOfBenefit diagnosis Information about diagnoses relevant to the claim items. ExplanationOfBenefit_Diagnosis
ExplanationOfBenefit procedure Procedures performed on the patient relevant to the billing items with the claim. ExplanationOfBenefit_Procedure
ExplanationOfBenefit precedence This indicates the relative order of a series of EOBs related to different coverages for the same suite of services. positiveInt
ExplanationOfBenefit _precedence Extensions for precedence Element
ExplanationOfBenefit insurance Financial instruments for reimbursement for the health care products and services specified on the claim. ExplanationOfBenefit_Insurance
ExplanationOfBenefit accident Details of a accident which resulted in injuries which required the products and services listed in the claim. ExplanationOfBenefit_Accident
ExplanationOfBenefit item 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
ExplanationOfBenefit addItem The first-tier service adjudications for payor added product or service lines. ExplanationOfBenefit_AddItem
ExplanationOfBenefit adjudication The adjudication results which are presented at the header level rather than at the line-item or add-item levels. ExplanationOfBenefit_Adjudication
ExplanationOfBenefit total Categorized monetary totals for the adjudication. ExplanationOfBenefit_Total
ExplanationOfBenefit payment Payment details for the adjudication of the claim. ExplanationOfBenefit_Payment
ExplanationOfBenefit formCode A code for the form to be used for printing the content. CodeableConcept
ExplanationOfBenefit form The actual form, by reference or inclusion, for printing the content or an EOB. Attachment
ExplanationOfBenefit processNote A note that describes or explains adjudication results in a human readable form. ExplanationOfBenefit_ProcessNote
ExplanationOfBenefit benefitPeriod The term of the benefits documented in this response. Period
ExplanationOfBenefit benefitBalance Balance by Benefit Category. ExplanationOfBenefit_BenefitBalance
ExplanationOfBenefit_Accident id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Accident extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Accident modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Accident date Date of an accident event related to the products and services contained in the claim. date
ExplanationOfBenefit_Accident _date Extensions for date Element
ExplanationOfBenefit_Accident type The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers. CodeableConcept
ExplanationOfBenefit_Accident locationAddress The physical location of the accident event. Address
ExplanationOfBenefit_Accident locationReference The physical location of the accident event. Reference
ExplanationOfBenefit_AddItem id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_AddItem extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_AddItem modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_AddItem itemSequence Claim items which this service line is intended to replace. positiveInt
ExplanationOfBenefit_AddItem _itemSequence Extensions for itemSequence Element
ExplanationOfBenefit_AddItem detailSequence The sequence number of the details within the claim item which this line is intended to replace. positiveInt
ExplanationOfBenefit_AddItem _detailSequence Extensions for detailSequence Element
ExplanationOfBenefit_AddItem subDetailSequence The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace. positiveInt
ExplanationOfBenefit_AddItem _subDetailSequence Extensions for subDetailSequence Element
ExplanationOfBenefit_AddItem provider The providers who are authorized for the services rendered to the patient. Reference
ExplanationOfBenefit_AddItem productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ExplanationOfBenefit_AddItem modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ExplanationOfBenefit_AddItem programCode Identifies the program under which this may be recovered. CodeableConcept
ExplanationOfBenefit_AddItem servicedDate The date or dates when the service or product was supplied, performed or completed. notDefined
ExplanationOfBenefit_AddItem _servicedDate Extensions for servicedDate Element
ExplanationOfBenefit_AddItem servicedPeriod The date or dates when the service or product was supplied, performed or completed. Period
ExplanationOfBenefit_AddItem locationCodeableConcept Where the product or service was provided. CodeableConcept
ExplanationOfBenefit_AddItem locationAddress Where the product or service was provided. Address
ExplanationOfBenefit_AddItem locationReference Where the product or service was provided. Reference
ExplanationOfBenefit_AddItem quantity The number of repetitions of a service or product. Quantity
ExplanationOfBenefit_AddItem unitPrice 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. Money
ExplanationOfBenefit_AddItem factor 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. decimal
ExplanationOfBenefit_AddItem _factor Extensions for factor Element
ExplanationOfBenefit_AddItem net The quantity times the unit price for an additional service or product or charge. Money
ExplanationOfBenefit_AddItem bodySite Physical service site on the patient (limb, tooth, etc.). CodeableConcept
ExplanationOfBenefit_AddItem subSite A region or surface of the bodySite, e.g. limb region or tooth surface(s). CodeableConcept
ExplanationOfBenefit_AddItem noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ExplanationOfBenefit_AddItem _noteNumber Extensions for noteNumber Element
ExplanationOfBenefit_AddItem adjudication The adjudication results. ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_AddItem detail The second-tier service adjudications for payor added services. ExplanationOfBenefit_Detail1
ExplanationOfBenefit_Adjudication id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Adjudication extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Adjudication modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Adjudication category 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. CodeableConcept
ExplanationOfBenefit_Adjudication reason A code supporting the understanding of the adjudication result and explaining variance from expected amount. CodeableConcept
ExplanationOfBenefit_Adjudication amount Monetary amount associated with the category. Money
ExplanationOfBenefit_Adjudication value A non-monetary value associated with the category. Mutually exclusive to the amount element above. decimal
ExplanationOfBenefit_Adjudication _value Extensions for value Element
ExplanationOfBenefit_BenefitBalance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_BenefitBalance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_BenefitBalance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_BenefitBalance category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
ExplanationOfBenefit_BenefitBalance excluded 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. boolean
ExplanationOfBenefit_BenefitBalance _excluded Extensions for excluded Element
ExplanationOfBenefit_BenefitBalance name A short name or tag for the benefit. string
ExplanationOfBenefit_BenefitBalance _name Extensions for name Element
ExplanationOfBenefit_BenefitBalance description A richer description of the benefit or services covered. string
ExplanationOfBenefit_BenefitBalance _description Extensions for description Element
ExplanationOfBenefit_BenefitBalance network Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers. CodeableConcept
ExplanationOfBenefit_BenefitBalance unit Indicates if the benefits apply to an individual or to the family. CodeableConcept
ExplanationOfBenefit_BenefitBalance term The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'. CodeableConcept
ExplanationOfBenefit_BenefitBalance financial Benefits Used to date. ExplanationOfBenefit_Financial
ExplanationOfBenefit_CareTeam id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_CareTeam extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_CareTeam modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_CareTeam sequence A number to uniquely identify care team entries. positiveInt
ExplanationOfBenefit_CareTeam _sequence Extensions for sequence Element
ExplanationOfBenefit_CareTeam provider Member of the team who provided the product or service. Reference
ExplanationOfBenefit_CareTeam responsible The party who is billing and/or responsible for the claimed products or services. boolean
ExplanationOfBenefit_CareTeam _responsible Extensions for responsible Element
ExplanationOfBenefit_CareTeam role The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team. CodeableConcept
ExplanationOfBenefit_CareTeam qualification The qualification of the practitioner which is applicable for this service. CodeableConcept
ExplanationOfBenefit_Detail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Detail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Detail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Detail sequence A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. positiveInt
ExplanationOfBenefit_Detail _sequence Extensions for sequence Element
ExplanationOfBenefit_Detail revenue The type of revenue or cost center providing the product and/or service. CodeableConcept
ExplanationOfBenefit_Detail category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
ExplanationOfBenefit_Detail productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ExplanationOfBenefit_Detail modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ExplanationOfBenefit_Detail programCode Identifies the program under which this may be recovered. CodeableConcept
ExplanationOfBenefit_Detail quantity The number of repetitions of a service or product. Quantity
ExplanationOfBenefit_Detail unitPrice 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. Money
ExplanationOfBenefit_Detail factor 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. decimal
ExplanationOfBenefit_Detail _factor Extensions for factor Element
ExplanationOfBenefit_Detail net The quantity times the unit price for an additional service or product or charge. Money
ExplanationOfBenefit_Detail udi Unique Device Identifiers associated with this line item. Reference
ExplanationOfBenefit_Detail noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ExplanationOfBenefit_Detail _noteNumber Extensions for noteNumber Element
ExplanationOfBenefit_Detail adjudication The adjudication results. ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_Detail subDetail Third-tier of goods and services. ExplanationOfBenefit_SubDetail
ExplanationOfBenefit_Detail1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Detail1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Detail1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Detail1 productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ExplanationOfBenefit_Detail1 modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ExplanationOfBenefit_Detail1 quantity The number of repetitions of a service or product. Quantity
ExplanationOfBenefit_Detail1 unitPrice 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. Money
ExplanationOfBenefit_Detail1 factor 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. decimal
ExplanationOfBenefit_Detail1 _factor Extensions for factor Element
ExplanationOfBenefit_Detail1 net The quantity times the unit price for an additional service or product or charge. Money
ExplanationOfBenefit_Detail1 noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ExplanationOfBenefit_Detail1 _noteNumber Extensions for noteNumber Element
ExplanationOfBenefit_Detail1 adjudication The adjudication results. ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_Detail1 subDetail The third-tier service adjudications for payor added services. ExplanationOfBenefit_SubDetail1
ExplanationOfBenefit_Diagnosis id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Diagnosis extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Diagnosis modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Diagnosis sequence A number to uniquely identify diagnosis entries. positiveInt
ExplanationOfBenefit_Diagnosis _sequence Extensions for sequence Element
ExplanationOfBenefit_Diagnosis diagnosisCodeableConcept The nature of illness or problem in a coded form or as a reference to an external defined Condition. CodeableConcept
ExplanationOfBenefit_Diagnosis diagnosisReference The nature of illness or problem in a coded form or as a reference to an external defined Condition. Reference
ExplanationOfBenefit_Diagnosis type When the condition was observed or the relative ranking. CodeableConcept
ExplanationOfBenefit_Diagnosis onAdmission Indication of whether the diagnosis was present on admission to a facility. CodeableConcept
ExplanationOfBenefit_Diagnosis packageCode 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. CodeableConcept
ExplanationOfBenefit_Financial id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Financial extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Financial modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Financial type Classification of benefit being provided. CodeableConcept
ExplanationOfBenefit_Financial allowedUnsignedInt The quantity of the benefit which is permitted under the coverage. notDefined
ExplanationOfBenefit_Financial _allowedUnsignedInt Extensions for allowedUnsignedInt Element
ExplanationOfBenefit_Financial allowedString The quantity of the benefit which is permitted under the coverage. notDefined
ExplanationOfBenefit_Financial _allowedString Extensions for allowedString Element
ExplanationOfBenefit_Financial allowedMoney The quantity of the benefit which is permitted under the coverage. Money
ExplanationOfBenefit_Financial usedUnsignedInt The quantity of the benefit which have been consumed to date. notDefined
ExplanationOfBenefit_Financial _usedUnsignedInt Extensions for usedUnsignedInt Element
ExplanationOfBenefit_Financial usedMoney The quantity of the benefit which have been consumed to date. Money
ExplanationOfBenefit_Insurance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Insurance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Insurance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Insurance focal A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true. boolean
ExplanationOfBenefit_Insurance _focal Extensions for focal Element
ExplanationOfBenefit_Insurance coverage 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. Reference
ExplanationOfBenefit_Insurance preAuthRef 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. string
ExplanationOfBenefit_Insurance _preAuthRef Extensions for preAuthRef Element
ExplanationOfBenefit_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Item sequence A number to uniquely identify item entries. positiveInt
ExplanationOfBenefit_Item _sequence Extensions for sequence Element
ExplanationOfBenefit_Item careTeamSequence Care team members related to this service or product. positiveInt
ExplanationOfBenefit_Item _careTeamSequence Extensions for careTeamSequence Element
ExplanationOfBenefit_Item diagnosisSequence Diagnoses applicable for this service or product. positiveInt
ExplanationOfBenefit_Item _diagnosisSequence Extensions for diagnosisSequence Element
ExplanationOfBenefit_Item procedureSequence Procedures applicable for this service or product. positiveInt
ExplanationOfBenefit_Item _procedureSequence Extensions for procedureSequence Element
ExplanationOfBenefit_Item informationSequence Exceptions, special conditions and supporting information applicable for this service or product. positiveInt
ExplanationOfBenefit_Item _informationSequence Extensions for informationSequence Element
ExplanationOfBenefit_Item revenue The type of revenue or cost center providing the product and/or service. CodeableConcept
ExplanationOfBenefit_Item category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
ExplanationOfBenefit_Item productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ExplanationOfBenefit_Item modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ExplanationOfBenefit_Item programCode Identifies the program under which this may be recovered. CodeableConcept
ExplanationOfBenefit_Item servicedDate The date or dates when the service or product was supplied, performed or completed. notDefined
ExplanationOfBenefit_Item _servicedDate Extensions for servicedDate Element
ExplanationOfBenefit_Item servicedPeriod The date or dates when the service or product was supplied, performed or completed. Period
ExplanationOfBenefit_Item locationCodeableConcept Where the product or service was provided. CodeableConcept
ExplanationOfBenefit_Item locationAddress Where the product or service was provided. Address
ExplanationOfBenefit_Item locationReference Where the product or service was provided. Reference
ExplanationOfBenefit_Item quantity The number of repetitions of a service or product. Quantity
ExplanationOfBenefit_Item unitPrice 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. Money
ExplanationOfBenefit_Item factor 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. decimal
ExplanationOfBenefit_Item _factor Extensions for factor Element
ExplanationOfBenefit_Item net The quantity times the unit price for an additional service or product or charge. Money
ExplanationOfBenefit_Item udi Unique Device Identifiers associated with this line item. Reference
ExplanationOfBenefit_Item bodySite Physical service site on the patient (limb, tooth, etc.). CodeableConcept
ExplanationOfBenefit_Item subSite A region or surface of the bodySite, e.g. limb region or tooth surface(s). CodeableConcept
ExplanationOfBenefit_Item encounter A billed item may include goods or services provided in multiple encounters. Reference
ExplanationOfBenefit_Item noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ExplanationOfBenefit_Item _noteNumber Extensions for noteNumber Element
ExplanationOfBenefit_Item adjudication 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_Adjudication
ExplanationOfBenefit_Item detail Second-tier of goods and services. ExplanationOfBenefit_Detail
ExplanationOfBenefit_Payee id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Payee extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Payee modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Payee type Type of Party to be reimbursed: Subscriber, provider, other. CodeableConcept
ExplanationOfBenefit_Payee party Reference to the individual or organization to whom any payment will be made. Reference
ExplanationOfBenefit_Payment id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Payment extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Payment modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Payment type Whether this represents partial or complete payment of the benefits payable. CodeableConcept
ExplanationOfBenefit_Payment adjustment Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication. Money
ExplanationOfBenefit_Payment adjustmentReason Reason for the payment adjustment. CodeableConcept
ExplanationOfBenefit_Payment date Estimated date the payment will be issued or the actual issue date of payment. date
ExplanationOfBenefit_Payment _date Extensions for date Element
ExplanationOfBenefit_Payment amount Benefits payable less any payment adjustment. Money
ExplanationOfBenefit_Payment identifier Issuer's unique identifier for the payment instrument. Identifier
ExplanationOfBenefit_Procedure id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Procedure extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Procedure modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Procedure sequence A number to uniquely identify procedure entries. positiveInt
ExplanationOfBenefit_Procedure _sequence Extensions for sequence Element
ExplanationOfBenefit_Procedure type When the condition was observed or the relative ranking. CodeableConcept
ExplanationOfBenefit_Procedure date Date and optionally time the procedure was performed. dateTime
ExplanationOfBenefit_Procedure _date Extensions for date Element
ExplanationOfBenefit_Procedure procedureCodeableConcept The code or reference to a Procedure resource which identifies the clinical intervention performed. CodeableConcept
ExplanationOfBenefit_Procedure procedureReference The code or reference to a Procedure resource which identifies the clinical intervention performed. Reference
ExplanationOfBenefit_Procedure udi Unique Device Identifiers associated with this line item. Reference
ExplanationOfBenefit_ProcessNote id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_ProcessNote extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_ProcessNote modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_ProcessNote number A number to uniquely identify a note entry. positiveInt
ExplanationOfBenefit_ProcessNote _number Extensions for number Element
ExplanationOfBenefit_ProcessNote type The business purpose of the note text. enum values:
display
print
printoper
ExplanationOfBenefit_ProcessNote _type Extensions for type Element
ExplanationOfBenefit_ProcessNote text The explanation or description associated with the processing. string
ExplanationOfBenefit_ProcessNote _text Extensions for text Element
ExplanationOfBenefit_ProcessNote language A code to define the language used in the text of the note. CodeableConcept
ExplanationOfBenefit_Related id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Related extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Related modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Related claim Reference to a related claim. Reference
ExplanationOfBenefit_Related relationship A code to convey how the claims are related. CodeableConcept
ExplanationOfBenefit_Related reference An alternate organizational reference to the case or file to which this particular claim pertains. Identifier
ExplanationOfBenefit_SubDetail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_SubDetail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_SubDetail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_SubDetail sequence A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. positiveInt
ExplanationOfBenefit_SubDetail _sequence Extensions for sequence Element
ExplanationOfBenefit_SubDetail revenue The type of revenue or cost center providing the product and/or service. CodeableConcept
ExplanationOfBenefit_SubDetail category Code to identify the general type of benefits under which products and services are provided. CodeableConcept
ExplanationOfBenefit_SubDetail productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ExplanationOfBenefit_SubDetail modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ExplanationOfBenefit_SubDetail programCode Identifies the program under which this may be recovered. CodeableConcept
ExplanationOfBenefit_SubDetail quantity The number of repetitions of a service or product. Quantity
ExplanationOfBenefit_SubDetail unitPrice 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. Money
ExplanationOfBenefit_SubDetail factor 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. decimal
ExplanationOfBenefit_SubDetail _factor Extensions for factor Element
ExplanationOfBenefit_SubDetail net The quantity times the unit price for an additional service or product or charge. Money
ExplanationOfBenefit_SubDetail udi Unique Device Identifiers associated with this line item. Reference
ExplanationOfBenefit_SubDetail noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ExplanationOfBenefit_SubDetail _noteNumber Extensions for noteNumber Element
ExplanationOfBenefit_SubDetail adjudication The adjudication results. ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_SubDetail1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_SubDetail1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_SubDetail1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_SubDetail1 productOrService When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item. CodeableConcept
ExplanationOfBenefit_SubDetail1 modifier Item typification or modifiers codes to convey additional context for the product or service. CodeableConcept
ExplanationOfBenefit_SubDetail1 quantity The number of repetitions of a service or product. Quantity
ExplanationOfBenefit_SubDetail1 unitPrice 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. Money
ExplanationOfBenefit_SubDetail1 factor 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. decimal
ExplanationOfBenefit_SubDetail1 _factor Extensions for factor Element
ExplanationOfBenefit_SubDetail1 net The quantity times the unit price for an additional service or product or charge. Money
ExplanationOfBenefit_SubDetail1 noteNumber The numbers associated with notes below which apply to the adjudication of this item. positiveInt
ExplanationOfBenefit_SubDetail1 _noteNumber Extensions for noteNumber Element
ExplanationOfBenefit_SubDetail1 adjudication The adjudication results. ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_SupportingInfo id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_SupportingInfo extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_SupportingInfo modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_SupportingInfo sequence A number to uniquely identify supporting information entries. positiveInt
ExplanationOfBenefit_SupportingInfo _sequence Extensions for sequence Element
ExplanationOfBenefit_SupportingInfo category The general class of the information supplied: information; exception; accident, employment; onset, etc. CodeableConcept
ExplanationOfBenefit_SupportingInfo code System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought. CodeableConcept
ExplanationOfBenefit_SupportingInfo timingDate The date when or period to which this information refers. notDefined
ExplanationOfBenefit_SupportingInfo _timingDate Extensions for timingDate Element
ExplanationOfBenefit_SupportingInfo timingPeriod The date when or period to which this information refers. Period
ExplanationOfBenefit_SupportingInfo valueBoolean Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. notDefined
ExplanationOfBenefit_SupportingInfo _valueBoolean Extensions for valueBoolean Element
ExplanationOfBenefit_SupportingInfo valueString Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. notDefined
ExplanationOfBenefit_SupportingInfo _valueString Extensions for valueString Element
ExplanationOfBenefit_SupportingInfo valueQuantity Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Quantity
ExplanationOfBenefit_SupportingInfo valueAttachment Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Attachment
ExplanationOfBenefit_SupportingInfo valueReference Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data. Reference
ExplanationOfBenefit_SupportingInfo reason Provides the reason in the situation where a reason code is required in addition to the content. Coding
ExplanationOfBenefit_Total id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ExplanationOfBenefit_Total extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ExplanationOfBenefit_Total modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ExplanationOfBenefit_Total category 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. CodeableConcept
ExplanationOfBenefit_Total amount Monetary total amount associated with the category. Money
Expression id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Expression extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Expression description A brief, natural language description of the condition that effectively communicates the intended semantics. string
Expression _description Extensions for description Element
Expression name A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined. id
Expression _name Extensions for name Element
Expression language The media type of the language for the expression. enum values:
text/cql
text/fhirpath
application/x-fhir-query
Expression _language Extensions for language Element
Expression expression An expression in the specified language that returns a value. string
Expression _expression Extensions for expression Element
Expression reference A URI that defines where the expression is found. uri
Expression _reference Extensions for reference Element
Extension id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Extension extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Extension url Source of the definition for the extension code - a logical name or a URL. uri
Extension _url Extensions for url Element
Extension valueBase64Binary Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueBase64Binary Extensions for valueBase64Binary Element
Extension valueBoolean Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueBoolean Extensions for valueBoolean Element
Extension valueCanonical Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueCanonical Extensions for valueCanonical Element
Extension valueCode Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueCode Extensions for valueCode Element
Extension valueDate Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueDate Extensions for valueDate Element
Extension valueDateTime Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueDateTime Extensions for valueDateTime Element
Extension valueDecimal Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueDecimal Extensions for valueDecimal Element
Extension valueId Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueId Extensions for valueId Element
Extension valueInstant Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueInstant Extensions for valueInstant Element
Extension valueInteger Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueInteger Extensions for valueInteger Element
Extension valueMarkdown Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueMarkdown Extensions for valueMarkdown Element
Extension valueOid Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueOid Extensions for valueOid Element
Extension valuePositiveInt Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valuePositiveInt Extensions for valuePositiveInt Element
Extension valueString Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueString Extensions for valueString Element
Extension valueTime Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueTime Extensions for valueTime Element
Extension valueUnsignedInt Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueUnsignedInt Extensions for valueUnsignedInt Element
Extension valueUri Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueUri Extensions for valueUri Element
Extension valueUrl Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueUrl Extensions for valueUrl Element
Extension valueUuid Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). notDefined
Extension _valueUuid Extensions for valueUuid Element
Extension valueAddress Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Address
Extension valueAge Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Age
Extension valueAnnotation Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Annotation
Extension valueAttachment Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Attachment
Extension valueCodeableConcept Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). CodeableConcept
Extension valueCoding Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Coding
Extension valueContactPoint Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). ContactPoint
Extension valueCount Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Count
Extension valueDistance Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Distance
Extension valueDuration Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Duration
Extension valueHumanName Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). HumanName
Extension valueIdentifier Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Identifier
Extension valueMoney Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Money
Extension valuePeriod Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Period
Extension valueQuantity Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Quantity
Extension valueRange Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Range
Extension valueRatio Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Ratio
Extension valueReference Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Reference
Extension valueSampledData Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). SampledData
Extension valueSignature Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Signature
Extension valueTiming Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Timing
Extension valueContactDetail Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). ContactDetail
Extension valueContributor Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Contributor
Extension valueDataRequirement Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). DataRequirement
Extension valueExpression Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Expression
Extension valueParameterDefinition Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). ParameterDefinition
Extension valueRelatedArtifact Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). RelatedArtifact
Extension valueTriggerDefinition Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). TriggerDefinition
Extension valueUsageContext Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). UsageContext
Extension valueDosage Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). Dosage
FamilyMemberHistory resourceType This is a FamilyMemberHistory resource FamilyMemberHistory
FamilyMemberHistory id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
FamilyMemberHistory meta 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. Meta
FamilyMemberHistory implicitRules 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. uri
FamilyMemberHistory _implicitRules Extensions for implicitRules Element
FamilyMemberHistory language The base language in which the resource is written. code
FamilyMemberHistory _language Extensions for language Element
FamilyMemberHistory text 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. Narrative
FamilyMemberHistory contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
FamilyMemberHistory extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
FamilyMemberHistory modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
FamilyMemberHistory identifier 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. Identifier
FamilyMemberHistory instantiatesCanonical 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. canonical
FamilyMemberHistory instantiatesUri 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. uri
FamilyMemberHistory _instantiatesUri Extensions for instantiatesUri Element
FamilyMemberHistory status A code specifying the status of the record of the family history of a specific family member. enum values:
partial
completed
entered-in-error
health-unknown
FamilyMemberHistory _status Extensions for status Element
FamilyMemberHistory dataAbsentReason Describes why the family member's history is not available. CodeableConcept
FamilyMemberHistory patient The person who this history concerns. Reference
FamilyMemberHistory date The date (and possibly time) when the family member history was recorded or last updated. dateTime
FamilyMemberHistory _date Extensions for date Element
FamilyMemberHistory name This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". string
FamilyMemberHistory _name Extensions for name Element
FamilyMemberHistory relationship The type of relationship this person has to the patient (father, mother, brother etc.). CodeableConcept
FamilyMemberHistory sex The birth sex of the family member. CodeableConcept
FamilyMemberHistory bornPeriod The actual or approximate date of birth of the relative. Period
FamilyMemberHistory bornDate The actual or approximate date of birth of the relative. notDefined
FamilyMemberHistory _bornDate Extensions for bornDate Element
FamilyMemberHistory bornString The actual or approximate date of birth of the relative. notDefined
FamilyMemberHistory _bornString Extensions for bornString Element
FamilyMemberHistory ageAge The age of the relative at the time the family member history is recorded. Age
FamilyMemberHistory ageRange The age of the relative at the time the family member history is recorded. Range
FamilyMemberHistory ageString The age of the relative at the time the family member history is recorded. notDefined
FamilyMemberHistory _ageString Extensions for ageString Element
FamilyMemberHistory estimatedAge If true, indicates that the age value specified is an estimated value. boolean
FamilyMemberHistory _estimatedAge Extensions for estimatedAge Element
FamilyMemberHistory deceasedBoolean Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. notDefined
FamilyMemberHistory _deceasedBoolean Extensions for deceasedBoolean Element
FamilyMemberHistory deceasedAge Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. Age
FamilyMemberHistory deceasedRange Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. Range
FamilyMemberHistory deceasedDate Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. notDefined
FamilyMemberHistory _deceasedDate Extensions for deceasedDate Element
FamilyMemberHistory deceasedString Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. notDefined
FamilyMemberHistory _deceasedString Extensions for deceasedString Element
FamilyMemberHistory reasonCode Describes why the family member history occurred in coded or textual form. CodeableConcept
FamilyMemberHistory reasonReference Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. Reference
FamilyMemberHistory note 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. Annotation
FamilyMemberHistory condition 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
FamilyMemberHistory_Condition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
FamilyMemberHistory_Condition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
FamilyMemberHistory_Condition modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
FamilyMemberHistory_Condition code 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. CodeableConcept
FamilyMemberHistory_Condition outcome Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. CodeableConcept
FamilyMemberHistory_Condition contributedToDeath This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown. boolean
FamilyMemberHistory_Condition _contributedToDeath Extensions for contributedToDeath Element
FamilyMemberHistory_Condition onsetAge 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. Age
FamilyMemberHistory_Condition onsetRange 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. Range
FamilyMemberHistory_Condition onsetPeriod 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. Period
FamilyMemberHistory_Condition onsetString 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. notDefined
FamilyMemberHistory_Condition _onsetString Extensions for onsetString Element
FamilyMemberHistory_Condition note An area where general notes can be placed about this specific condition. Annotation
Flag resourceType This is a Flag resource Flag
Flag id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Flag meta 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. Meta
Flag implicitRules 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. uri
Flag _implicitRules Extensions for implicitRules Element
Flag language The base language in which the resource is written. code
Flag _language Extensions for language Element
Flag text 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. Narrative
Flag contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Flag extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Flag modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Flag identifier 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. Identifier
Flag status Supports basic workflow. enum values:
active
inactive
entered-in-error
Flag _status Extensions for status Element
Flag category 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. CodeableConcept
Flag code The coded value or textual component of the flag to display to the user. CodeableConcept
Flag subject The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. Reference
Flag period 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. Period
Flag encounter This alert is only relevant during the encounter. Reference
Flag author The person, organization or device that created the flag. Reference
Goal resourceType This is a Goal resource Goal
Goal id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Goal meta 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. Meta
Goal implicitRules 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. uri
Goal _implicitRules Extensions for implicitRules Element
Goal language The base language in which the resource is written. code
Goal _language Extensions for language Element
Goal text 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. Narrative
Goal contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Goal extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Goal modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Goal identifier 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. Identifier
Goal lifecycleStatus The state of the goal throughout its lifecycle. enum values:
proposed
planned
accepted
active
on-hold
completed
cancelled
entered-in-error
rejected
Goal _lifecycleStatus Extensions for lifecycleStatus Element
Goal achievementStatus Describes the progression, or lack thereof, towards the goal against the target. CodeableConcept
Goal category Indicates a category the goal falls within. CodeableConcept
Goal priority Identifies the mutually agreed level of importance associated with reaching/sustaining the goal. CodeableConcept
Goal description 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". CodeableConcept
Goal subject Identifies the patient, group or organization for whom the goal is being established. Reference
Goal startDate The date or event after which the goal should begin being pursued. notDefined
Goal _startDate Extensions for startDate Element
Goal startCodeableConcept The date or event after which the goal should begin being pursued. CodeableConcept
Goal target Indicates what should be done by when. Goal_Target
Goal statusDate Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc. date
Goal _statusDate Extensions for statusDate Element
Goal statusReason Captures the reason for the current status. string
Goal _statusReason Extensions for statusReason Element
Goal expressedBy Indicates whose goal this is - patient goal, practitioner goal, etc. Reference
Goal addresses The identified conditions and other health record elements that are intended to be addressed by the goal. Reference
Goal note Any comments related to the goal. Annotation
Goal outcomeCode Identifies the change (or lack of change) at the point when the status of the goal is assessed. CodeableConcept
Goal outcomeReference Details of what's changed (or not changed). Reference
Goal_Target id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Goal_Target extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Goal_Target modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Goal_Target measure The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. CodeableConcept
Goal_Target detailQuantity 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. Quantity
Goal_Target detailRange 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. Range
Goal_Target detailCodeableConcept 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. CodeableConcept
Goal_Target detailString 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. notDefined
Goal_Target _detailString Extensions for detailString Element
Goal_Target detailBoolean 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. notDefined
Goal_Target _detailBoolean Extensions for detailBoolean Element
Goal_Target detailInteger 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. notDefined
Goal_Target _detailInteger Extensions for detailInteger Element
Goal_Target detailRatio 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. Ratio
Goal_Target dueDate Indicates either the date or the duration after start by which the goal should be met. notDefined
Goal_Target _dueDate Extensions for dueDate Element
Goal_Target dueDuration Indicates either the date or the duration after start by which the goal should be met. Duration
GraphDefinition resourceType This is a GraphDefinition resource GraphDefinition
GraphDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
GraphDefinition meta 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. Meta
GraphDefinition implicitRules 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. uri
GraphDefinition _implicitRules Extensions for implicitRules Element
GraphDefinition language The base language in which the resource is written. code
GraphDefinition _language Extensions for language Element
GraphDefinition text 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. Narrative
GraphDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
GraphDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
GraphDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
GraphDefinition url 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 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. uri
GraphDefinition _url Extensions for url Element
GraphDefinition version 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. string
GraphDefinition _version Extensions for version Element
GraphDefinition name 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. string
GraphDefinition _name Extensions for name Element
GraphDefinition status The status of this graph definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
GraphDefinition _status Extensions for status Element
GraphDefinition experimental 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. boolean
GraphDefinition _experimental Extensions for experimental Element
GraphDefinition date The date (and optionally time) when the graph definition 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 graph definition changes. dateTime
GraphDefinition _date Extensions for date Element
GraphDefinition publisher The name of the organization or individual that published the graph definition. string
GraphDefinition _publisher Extensions for publisher Element
GraphDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
GraphDefinition description A free text natural language description of the graph definition from a consumer's perspective. markdown
GraphDefinition _description Extensions for description Element
GraphDefinition useContext 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. UsageContext
GraphDefinition jurisdiction A legal or geographic region in which the graph definition is intended to be used. CodeableConcept
GraphDefinition purpose Explanation of why this graph definition is needed and why it has been designed as it has. markdown
GraphDefinition _purpose Extensions for purpose Element
GraphDefinition start The type of FHIR resource at which instances of this graph start. code
GraphDefinition _start Extensions for start Element
GraphDefinition profile The profile that describes the use of the base resource. canonical
GraphDefinition link Links this graph makes rules about. GraphDefinition_Link
GraphDefinition_Compartment id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
GraphDefinition_Compartment extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
GraphDefinition_Compartment modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
GraphDefinition_Compartment use 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. enum values:
condition
requirement
GraphDefinition_Compartment _use Extensions for use Element
GraphDefinition_Compartment code Identifies the compartment. code
GraphDefinition_Compartment _code Extensions for code Element
GraphDefinition_Compartment rule identical | matching | different | no-rule | custom. enum values:
identical
matching
different
custom
GraphDefinition_Compartment _rule Extensions for rule Element
GraphDefinition_Compartment expression Custom rule, as a FHIRPath expression. string
GraphDefinition_Compartment _expression Extensions for expression Element
GraphDefinition_Compartment description Documentation for FHIRPath expression. string
GraphDefinition_Compartment _description Extensions for description Element
GraphDefinition_Link id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
GraphDefinition_Link extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
GraphDefinition_Link modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
GraphDefinition_Link path A FHIR expression that identifies one of FHIR References to other resources. string
GraphDefinition_Link _path Extensions for path Element
GraphDefinition_Link sliceName Which slice (if profiled). string
GraphDefinition_Link _sliceName Extensions for sliceName Element
GraphDefinition_Link min Minimum occurrences for this link. integer
GraphDefinition_Link _min Extensions for min Element
GraphDefinition_Link max Maximum occurrences for this link. string
GraphDefinition_Link _max Extensions for max Element
GraphDefinition_Link description Information about why this link is of interest in this graph definition. string
GraphDefinition_Link _description Extensions for description Element
GraphDefinition_Link target Potential target for the link. GraphDefinition_Target
GraphDefinition_Target id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
GraphDefinition_Target extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
GraphDefinition_Target modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
GraphDefinition_Target type Type of resource this link refers to. code
GraphDefinition_Target _type Extensions for type Element
GraphDefinition_Target params A set of parameters to look up. string
GraphDefinition_Target _params Extensions for params Element
GraphDefinition_Target profile Profile for the target resource. canonical
GraphDefinition_Target compartment Compartment Consistency Rules. GraphDefinition_Compartment
GraphDefinition_Target link Additional links from target resource. GraphDefinition_Link
Group resourceType This is a Group resource Group
Group id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Group meta 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. Meta
Group implicitRules 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. uri
Group _implicitRules Extensions for implicitRules Element
Group language The base language in which the resource is written. code
Group _language Extensions for language Element
Group text 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. Narrative
Group contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Group extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Group modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Group identifier A unique business identifier for this group. Identifier
Group active Indicates whether the record for the group is available for use or is merely being retained for historical purposes. boolean
Group _active Extensions for active Element
Group type Identifies the broad classification of the kind of resources the group includes. enum values:
person
animal
practitioner
device
medication
substance
Group _type Extensions for type Element
Group actual If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. boolean
Group _actual Extensions for actual Element
Group code Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. CodeableConcept
Group name A label assigned to the group for human identification and communication. string
Group _name Extensions for name Element
Group quantity A count of the number of resource instances that are part of the group. unsignedInt
Group _quantity Extensions for quantity Element
Group managingEntity Entity responsible for defining and maintaining Group characteristics and/or registered members. Reference
Group characteristic Identifies traits whose presence r absence is shared by members of the group. Group_Characteristic
Group member Identifies the resource instances that are members of the group. Group_Member
Group_Characteristic id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Group_Characteristic extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Group_Characteristic modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Group_Characteristic code A code that identifies the kind of trait being asserted. CodeableConcept
Group_Characteristic valueCodeableConcept The value of the trait that holds (or does not hold - see 'exclude') for members of the group. CodeableConcept
Group_Characteristic valueBoolean The value of the trait that holds (or does not hold - see 'exclude') for members of the group. notDefined
Group_Characteristic _valueBoolean Extensions for valueBoolean Element
Group_Characteristic valueQuantity The value of the trait that holds (or does not hold - see 'exclude') for members of the group. Quantity
Group_Characteristic valueRange The value of the trait that holds (or does not hold - see 'exclude') for members of the group. Range
Group_Characteristic valueReference The value of the trait that holds (or does not hold - see 'exclude') for members of the group. Reference
Group_Characteristic exclude If true, indicates the characteristic is one that is NOT held by members of the group. boolean
Group_Characteristic _exclude Extensions for exclude Element
Group_Characteristic period The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. Period
Group_Member id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Group_Member extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Group_Member modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Group_Member entity 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. Reference
Group_Member period The period that the member was in the group, if known. Period
Group_Member inactive A flag to indicate that the member is no longer in the group, but previously may have been a member. boolean
Group_Member _inactive Extensions for inactive Element
GuidanceResponse resourceType This is a GuidanceResponse resource GuidanceResponse
GuidanceResponse id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
GuidanceResponse meta 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. Meta
GuidanceResponse implicitRules 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. uri
GuidanceResponse _implicitRules Extensions for implicitRules Element
GuidanceResponse language The base language in which the resource is written. code
GuidanceResponse _language Extensions for language Element
GuidanceResponse text 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. Narrative
GuidanceResponse contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
GuidanceResponse extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
GuidanceResponse modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
GuidanceResponse requestIdentifier 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. Identifier
GuidanceResponse identifier Allows a service to provide unique, business identifiers for the response. Identifier
GuidanceResponse moduleUri An identifier, CodeableConcept or canonical reference to the guidance that was requested. notDefined
GuidanceResponse _moduleUri Extensions for moduleUri Element
GuidanceResponse moduleCanonical An identifier, CodeableConcept or canonical reference to the guidance that was requested. notDefined
GuidanceResponse _moduleCanonical Extensions for moduleCanonical Element
GuidanceResponse moduleCodeableConcept An identifier, CodeableConcept or canonical reference to the guidance that was requested. CodeableConcept
GuidanceResponse status 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. enum values:
success
data-requested
data-required
in-progress
failure
entered-in-error
GuidanceResponse _status Extensions for status Element
GuidanceResponse subject The patient for which the request was processed. Reference
GuidanceResponse encounter The encounter during which this response was created or to which the creation of this record is tightly associated. Reference
GuidanceResponse occurrenceDateTime Indicates when the guidance response was processed. dateTime
GuidanceResponse _occurrenceDateTime Extensions for occurrenceDateTime Element
GuidanceResponse performer Provides a reference to the device that performed the guidance. Reference
GuidanceResponse reasonCode Describes the reason for the guidance response in coded or textual form. CodeableConcept
GuidanceResponse reasonReference 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. Reference
GuidanceResponse note Provides a mechanism to communicate additional information about the response. Annotation
GuidanceResponse evaluationMessage 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. Reference
GuidanceResponse outputParameters 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. Reference
GuidanceResponse result The actions, if any, produced by the evaluation of the artifact. Reference
GuidanceResponse dataRequirement 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. DataRequirement
HealthcareService resourceType This is a HealthcareService resource HealthcareService
HealthcareService id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
HealthcareService meta 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. Meta
HealthcareService implicitRules 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. uri
HealthcareService _implicitRules Extensions for implicitRules Element
HealthcareService language The base language in which the resource is written. code
HealthcareService _language Extensions for language Element
HealthcareService text 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. Narrative
HealthcareService contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
HealthcareService extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
HealthcareService modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
HealthcareService identifier External identifiers for this item. Identifier
HealthcareService active 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. boolean
HealthcareService _active Extensions for active Element
HealthcareService providedBy The organization that provides this healthcare service. Reference
HealthcareService category Identifies the broad category of service being performed or delivered. CodeableConcept
HealthcareService type The specific type of service that may be delivered or performed. CodeableConcept
HealthcareService specialty Collection of specialties handled by the service site. This is more of a medical term. CodeableConcept
HealthcareService location The location(s) where this healthcare service may be provided. Reference
HealthcareService name Further description of the service as it would be presented to a consumer while searching. string
HealthcareService _name Extensions for name Element
HealthcareService comment 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. string
HealthcareService _comment Extensions for comment Element
HealthcareService extraDetails Extra details about the service that can't be placed in the other fields. markdown
HealthcareService _extraDetails Extensions for extraDetails Element
HealthcareService photo 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. Attachment
HealthcareService telecom List of contacts related to this specific healthcare service. ContactPoint
HealthcareService coverageArea The location(s) that this service is available to (not where the service is provided). Reference
HealthcareService serviceProvisionCode The code(s) that detail the conditions under which the healthcare service is available/offered. CodeableConcept
HealthcareService eligibility Does this service have specific eligibility requirements that need to be met in order to use the service? HealthcareService_Eligibility
HealthcareService program Programs that this service is applicable to. CodeableConcept
HealthcareService characteristic Collection of characteristics (attributes). CodeableConcept
HealthcareService communication 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. CodeableConcept
HealthcareService referralMethod Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. CodeableConcept
HealthcareService appointmentRequired 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. boolean
HealthcareService _appointmentRequired Extensions for appointmentRequired Element
HealthcareService availableTime A collection of times that the Service Site is available. HealthcareService_AvailableTime
HealthcareService notAvailable The HealthcareService is not available during this period of time due to the provided reason. HealthcareService_NotAvailable
HealthcareService availabilityExceptions A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. string
HealthcareService _availabilityExceptions Extensions for availabilityExceptions Element
HealthcareService endpoint Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. Reference
HealthcareService_AvailableTime id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
HealthcareService_AvailableTime extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
HealthcareService_AvailableTime modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
HealthcareService_AvailableTime daysOfWeek Indicates which days of the week are available between the start and end Times. enum values:
mon
tue
wed
thu
fri
sat
sun
HealthcareService_AvailableTime _daysOfWeek Extensions for daysOfWeek Element
HealthcareService_AvailableTime allDay Is this always available? (hence times are irrelevant) e.g. 24 hour service. boolean
HealthcareService_AvailableTime _allDay Extensions for allDay Element
HealthcareService_AvailableTime availableStartTime The opening time of day. Note: If the AllDay flag is set, then this time is ignored. time
HealthcareService_AvailableTime _availableStartTime Extensions for availableStartTime Element
HealthcareService_AvailableTime availableEndTime The closing time of day. Note: If the AllDay flag is set, then this time is ignored. time
HealthcareService_AvailableTime _availableEndTime Extensions for availableEndTime Element
HealthcareService_Eligibility id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
HealthcareService_Eligibility extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
HealthcareService_Eligibility modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
HealthcareService_Eligibility code Coded value for the eligibility. CodeableConcept
HealthcareService_Eligibility comment Describes the eligibility conditions for the service. markdown
HealthcareService_Eligibility _comment Extensions for comment Element
HealthcareService_NotAvailable id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
HealthcareService_NotAvailable extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
HealthcareService_NotAvailable modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
HealthcareService_NotAvailable description The reason that can be presented to the user as to why this time is not available. string
HealthcareService_NotAvailable _description Extensions for description Element
HealthcareService_NotAvailable during Service is not available (seasonally or for a public holiday) from this date. Period
HumanName id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
HumanName extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
HumanName use Identifies the purpose for this name. enum values:
usual
official
temp
nickname
anonymous
old
maiden
HumanName _use Extensions for use Element
HumanName text 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. string
HumanName _text Extensions for text Element
HumanName family 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. string
HumanName _family Extensions for family Element
HumanName given Given name. string
HumanName _given Extensions for given Element
HumanName prefix 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. string
HumanName _prefix Extensions for prefix Element
HumanName suffix 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. string
HumanName _suffix Extensions for suffix Element
HumanName period Indicates the period of time when this name was valid for the named person. Period
Identifier id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Identifier extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Identifier use The purpose of this identifier. enum values:
usual
official
temp
secondary
old
Identifier _use Extensions for use Element
Identifier type A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. CodeableConcept
Identifier system Establishes the namespace for the value - that is, a URL that describes a set values that are unique. uri
Identifier _system Extensions for system Element
Identifier value The portion of the identifier typically relevant to the user and which is unique within the context of the system. string
Identifier _value Extensions for value Element
Identifier period Time period during which identifier is/was valid for use. Period
Identifier assigner Organization that issued/manages the identifier. Reference
ImagingStudy resourceType This is a ImagingStudy resource ImagingStudy
ImagingStudy id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ImagingStudy meta 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. Meta
ImagingStudy implicitRules 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. uri
ImagingStudy _implicitRules Extensions for implicitRules Element
ImagingStudy language The base language in which the resource is written. code
ImagingStudy _language Extensions for language Element
ImagingStudy text 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. Narrative
ImagingStudy contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ImagingStudy extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImagingStudy modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImagingStudy identifier Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. Identifier
ImagingStudy status The current state of the ImagingStudy. enum values:
registered
available
cancelled
entered-in-error
unknown
ImagingStudy _status Extensions for status Element
ImagingStudy modality A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). Coding
ImagingStudy subject The subject, typically a patient, of the imaging study. Reference
ImagingStudy encounter The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. Reference
ImagingStudy started Date and time the study started. dateTime
ImagingStudy _started Extensions for started Element
ImagingStudy basedOn A list of the diagnostic requests that resulted in this imaging study being performed. Reference
ImagingStudy referrer The requesting/referring physician. Reference
ImagingStudy interpreter Who read the study and interpreted the images or other content. Reference
ImagingStudy endpoint 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. Reference
ImagingStudy numberOfSeries 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. unsignedInt
ImagingStudy _numberOfSeries Extensions for numberOfSeries Element
ImagingStudy numberOfInstances 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. unsignedInt
ImagingStudy _numberOfInstances Extensions for numberOfInstances Element
ImagingStudy procedureReference The procedure which this ImagingStudy was part of. Reference
ImagingStudy procedureCode The code for the performed procedure type. CodeableConcept
ImagingStudy location The principal physical location where the ImagingStudy was performed. Reference
ImagingStudy reasonCode Description of clinical condition indicating why the ImagingStudy was requested. CodeableConcept
ImagingStudy reasonReference Indicates another resource whose existence justifies this Study. Reference
ImagingStudy note 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. Annotation
ImagingStudy description The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed. string
ImagingStudy _description Extensions for description Element
ImagingStudy series Each study has one or more series of images or other content. ImagingStudy_Series
ImagingStudy_Instance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImagingStudy_Instance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImagingStudy_Instance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImagingStudy_Instance uid The DICOM SOP Instance UID for this image or other DICOM content. id
ImagingStudy_Instance _uid Extensions for uid Element
ImagingStudy_Instance sopClass DICOM instance type. Coding
ImagingStudy_Instance number The number of instance in the series. unsignedInt
ImagingStudy_Instance _number Extensions for number Element
ImagingStudy_Instance title The description of the instance. string
ImagingStudy_Instance _title Extensions for title Element
ImagingStudy_Performer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImagingStudy_Performer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImagingStudy_Performer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImagingStudy_Performer function Distinguishes the type of involvement of the performer in the series. CodeableConcept
ImagingStudy_Performer actor Indicates who or what performed the series. Reference
ImagingStudy_Series id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImagingStudy_Series extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImagingStudy_Series modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImagingStudy_Series uid The DICOM Series Instance UID for the series. id
ImagingStudy_Series _uid Extensions for uid Element
ImagingStudy_Series number The numeric identifier of this series in the study. unsignedInt
ImagingStudy_Series _number Extensions for number Element
ImagingStudy_Series modality The modality of this series sequence. Coding
ImagingStudy_Series description A description of the series. string
ImagingStudy_Series _description Extensions for description Element
ImagingStudy_Series numberOfInstances 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. unsignedInt
ImagingStudy_Series _numberOfInstances Extensions for numberOfInstances Element
ImagingStudy_Series endpoint 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. Reference
ImagingStudy_Series bodySite 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. Coding
ImagingStudy_Series laterality 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. Coding
ImagingStudy_Series specimen The specimen imaged, e.g., for whole slide imaging of a biopsy. Reference
ImagingStudy_Series started The date and time the series was started. dateTime
ImagingStudy_Series _started Extensions for started Element
ImagingStudy_Series performer Indicates who or what performed the series and how they were involved. ImagingStudy_Performer
ImagingStudy_Series instance A single SOP instance within the series, e.g. an image, or presentation state. ImagingStudy_Instance
Immunization resourceType This is a Immunization resource Immunization
Immunization id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Immunization meta 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. Meta
Immunization implicitRules 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. uri
Immunization _implicitRules Extensions for implicitRules Element
Immunization language The base language in which the resource is written. code
Immunization _language Extensions for language Element
Immunization text 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. Narrative
Immunization contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Immunization extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Immunization modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Immunization identifier A unique identifier assigned to this immunization record. Identifier
Immunization status Indicates the current status of the immunization event. code
Immunization _status Extensions for status Element
Immunization statusReason Indicates the reason the immunization event was not performed. CodeableConcept
Immunization vaccineCode Vaccine that was administered or was to be administered. CodeableConcept
Immunization patient The patient who either received or did not receive the immunization. Reference
Immunization encounter The visit or admission or other contact between patient and health care provider the immunization was performed as part of. Reference
Immunization occurrenceDateTime Date vaccine administered or was to be administered. notDefined
Immunization _occurrenceDateTime Extensions for occurrenceDateTime Element
Immunization occurrenceString Date vaccine administered or was to be administered. notDefined
Immunization _occurrenceString Extensions for occurrenceString Element
Immunization recorded The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. dateTime
Immunization _recorded Extensions for recorded Element
Immunization primarySource An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. boolean
Immunization _primarySource Extensions for primarySource Element
Immunization reportOrigin The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. CodeableConcept
Immunization location The service delivery location where the vaccine administration occurred. Reference
Immunization manufacturer Name of vaccine manufacturer. Reference
Immunization lotNumber Lot number of the vaccine product. string
Immunization _lotNumber Extensions for lotNumber Element
Immunization expirationDate Date vaccine batch expires. date
Immunization _expirationDate Extensions for expirationDate Element
Immunization site Body site where vaccine was administered. CodeableConcept
Immunization route The path by which the vaccine product is taken into the body. CodeableConcept
Immunization doseQuantity The quantity of vaccine product that was administered. Quantity
Immunization performer Indicates who performed the immunization event. Immunization_Performer
Immunization note Extra information about the immunization that is not conveyed by the other attributes. Annotation
Immunization reasonCode Reasons why the vaccine was administered. CodeableConcept
Immunization reasonReference Condition, Observation or DiagnosticReport that supports why the immunization was administered. Reference
Immunization isSubpotent Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. boolean
Immunization _isSubpotent Extensions for isSubpotent Element
Immunization subpotentReason Reason why a dose is considered to be subpotent. CodeableConcept
Immunization education Educational material presented to the patient (or guardian) at the time of vaccine administration. Immunization_Education
Immunization programEligibility Indicates a patient's eligibility for a funding program. CodeableConcept
Immunization fundingSource 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). CodeableConcept
Immunization reaction Categorical data indicating that an adverse event is associated in time to an immunization. Immunization_Reaction
Immunization protocolApplied The protocol (set of recommendations) being followed by the provider who administered the dose. Immunization_ProtocolApplied
ImmunizationEvaluation resourceType This is a ImmunizationEvaluation resource ImmunizationEvaluation
ImmunizationEvaluation id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ImmunizationEvaluation meta 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. Meta
ImmunizationEvaluation implicitRules 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. uri
ImmunizationEvaluation _implicitRules Extensions for implicitRules Element
ImmunizationEvaluation language The base language in which the resource is written. code
ImmunizationEvaluation _language Extensions for language Element
ImmunizationEvaluation text 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. Narrative
ImmunizationEvaluation contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ImmunizationEvaluation extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImmunizationEvaluation modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImmunizationEvaluation identifier A unique identifier assigned to this immunization evaluation record. Identifier
ImmunizationEvaluation status Indicates the current status of the evaluation of the vaccination administration event. code
ImmunizationEvaluation _status Extensions for status Element
ImmunizationEvaluation patient The individual for whom the evaluation is being done. Reference
ImmunizationEvaluation date The date the evaluation of the vaccine administration event was performed. dateTime
ImmunizationEvaluation _date Extensions for date Element
ImmunizationEvaluation authority Indicates the authority who published the protocol (e.g. ACIP). Reference
ImmunizationEvaluation targetDisease The vaccine preventable disease the dose is being evaluated against. CodeableConcept
ImmunizationEvaluation immunizationEvent The vaccine administration event being evaluated. Reference
ImmunizationEvaluation doseStatus Indicates if the dose is valid or not valid with respect to the published recommendations. CodeableConcept
ImmunizationEvaluation doseStatusReason Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. CodeableConcept
ImmunizationEvaluation description Additional information about the evaluation. string
ImmunizationEvaluation _description Extensions for description Element
ImmunizationEvaluation series One possible path to achieve presumed immunity against a disease - within the context of an authority. string
ImmunizationEvaluation _series Extensions for series Element
ImmunizationEvaluation doseNumberPositiveInt Nominal position in a series. notDefined
ImmunizationEvaluation _doseNumberPositiveInt Extensions for doseNumberPositiveInt Element
ImmunizationEvaluation doseNumberString Nominal position in a series. notDefined
ImmunizationEvaluation _doseNumberString Extensions for doseNumberString Element
ImmunizationEvaluation seriesDosesPositiveInt The recommended number of doses to achieve immunity. notDefined
ImmunizationEvaluation _seriesDosesPositiveInt Extensions for seriesDosesPositiveInt Element
ImmunizationEvaluation seriesDosesString The recommended number of doses to achieve immunity. notDefined
ImmunizationEvaluation _seriesDosesString Extensions for seriesDosesString Element
ImmunizationRecommendation resourceType This is a ImmunizationRecommendation resource ImmunizationRecommendation
ImmunizationRecommendation id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ImmunizationRecommendation meta 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. Meta
ImmunizationRecommendation implicitRules 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. uri
ImmunizationRecommendation _implicitRules Extensions for implicitRules Element
ImmunizationRecommendation language The base language in which the resource is written. code
ImmunizationRecommendation _language Extensions for language Element
ImmunizationRecommendation text 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. Narrative
ImmunizationRecommendation contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ImmunizationRecommendation extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImmunizationRecommendation modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImmunizationRecommendation identifier A unique identifier assigned to this particular recommendation record. Identifier
ImmunizationRecommendation patient The patient the recommendation(s) are for. Reference
ImmunizationRecommendation date The date the immunization recommendation(s) were created. dateTime
ImmunizationRecommendation _date Extensions for date Element
ImmunizationRecommendation authority Indicates the authority who published the protocol (e.g. ACIP). Reference
ImmunizationRecommendation recommendation Vaccine administration recommendations. ImmunizationRecommendation_Recommendation
ImmunizationRecommendation_DateCriterion id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImmunizationRecommendation_DateCriterion extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImmunizationRecommendation_DateCriterion modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImmunizationRecommendation_DateCriterion code Date classification of recommendation. For example, earliest date to give, latest date to give, etc. CodeableConcept
ImmunizationRecommendation_DateCriterion value The date whose meaning is specified by dateCriterion.code. dateTime
ImmunizationRecommendation_DateCriterion _value Extensions for value Element
ImmunizationRecommendation_Recommendation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImmunizationRecommendation_Recommendation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImmunizationRecommendation_Recommendation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImmunizationRecommendation_Recommendation vaccineCode Vaccine(s) or vaccine group that pertain to the recommendation. CodeableConcept
ImmunizationRecommendation_Recommendation targetDisease The targeted disease for the recommendation. CodeableConcept
ImmunizationRecommendation_Recommendation contraindicatedVaccineCode Vaccine(s) which should not be used to fulfill the recommendation. CodeableConcept
ImmunizationRecommendation_Recommendation forecastStatus Indicates the patient status with respect to the path to immunity for the target disease. CodeableConcept
ImmunizationRecommendation_Recommendation forecastReason The reason for the assigned forecast status. CodeableConcept
ImmunizationRecommendation_Recommendation dateCriterion Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. ImmunizationRecommendation_DateCriterion
ImmunizationRecommendation_Recommendation description Contains the description about the protocol under which the vaccine was administered. string
ImmunizationRecommendation_Recommendation _description Extensions for description Element
ImmunizationRecommendation_Recommendation series One possible path to achieve presumed immunity against a disease - within the context of an authority. string
ImmunizationRecommendation_Recommendation _series Extensions for series Element
ImmunizationRecommendation_Recommendation doseNumberPositiveInt Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose). notDefined
ImmunizationRecommendation_Recommendation _doseNumberPositiveInt Extensions for doseNumberPositiveInt Element
ImmunizationRecommendation_Recommendation doseNumberString Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose). notDefined
ImmunizationRecommendation_Recommendation _doseNumberString Extensions for doseNumberString Element
ImmunizationRecommendation_Recommendation seriesDosesPositiveInt The recommended number of doses to achieve immunity. notDefined
ImmunizationRecommendation_Recommendation _seriesDosesPositiveInt Extensions for seriesDosesPositiveInt Element
ImmunizationRecommendation_Recommendation seriesDosesString The recommended number of doses to achieve immunity. notDefined
ImmunizationRecommendation_Recommendation _seriesDosesString Extensions for seriesDosesString Element
ImmunizationRecommendation_Recommendation supportingImmunization Immunization event history and/or evaluation that supports the status and recommendation. Reference
ImmunizationRecommendation_Recommendation supportingPatientInformation Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. Reference
Immunization_Education id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Immunization_Education extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Immunization_Education modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Immunization_Education documentType Identifier of the material presented to the patient. string
Immunization_Education _documentType Extensions for documentType Element
Immunization_Education reference Reference pointer to the educational material given to the patient if the information was on line. uri
Immunization_Education _reference Extensions for reference Element
Immunization_Education publicationDate Date the educational material was published. dateTime
Immunization_Education _publicationDate Extensions for publicationDate Element
Immunization_Education presentationDate Date the educational material was given to the patient. dateTime
Immunization_Education _presentationDate Extensions for presentationDate Element
Immunization_Performer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Immunization_Performer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Immunization_Performer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Immunization_Performer function Describes the type of performance (e.g. ordering provider, administering provider, etc.). CodeableConcept
Immunization_Performer actor The practitioner or organization who performed the action. Reference
Immunization_ProtocolApplied id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Immunization_ProtocolApplied extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Immunization_ProtocolApplied modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Immunization_ProtocolApplied series One possible path to achieve presumed immunity against a disease - within the context of an authority. string
Immunization_ProtocolApplied _series Extensions for series Element
Immunization_ProtocolApplied authority Indicates the authority who published the protocol (e.g. ACIP) that is being followed. Reference
Immunization_ProtocolApplied targetDisease The vaccine preventable disease the dose is being administered against. CodeableConcept
Immunization_ProtocolApplied doseNumberPositiveInt Nominal position in a series. notDefined
Immunization_ProtocolApplied _doseNumberPositiveInt Extensions for doseNumberPositiveInt Element
Immunization_ProtocolApplied doseNumberString Nominal position in a series. notDefined
Immunization_ProtocolApplied _doseNumberString Extensions for doseNumberString Element
Immunization_ProtocolApplied seriesDosesPositiveInt The recommended number of doses to achieve immunity. notDefined
Immunization_ProtocolApplied _seriesDosesPositiveInt Extensions for seriesDosesPositiveInt Element
Immunization_ProtocolApplied seriesDosesString The recommended number of doses to achieve immunity. notDefined
Immunization_ProtocolApplied _seriesDosesString Extensions for seriesDosesString Element
Immunization_Reaction id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Immunization_Reaction extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Immunization_Reaction modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Immunization_Reaction date Date of reaction to the immunization. dateTime
Immunization_Reaction _date Extensions for date Element
Immunization_Reaction detail Details of the reaction. Reference
Immunization_Reaction reported Self-reported indicator. boolean
Immunization_Reaction _reported Extensions for reported Element
ImplementationGuide resourceType This is a ImplementationGuide resource ImplementationGuide
ImplementationGuide id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ImplementationGuide meta 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. Meta
ImplementationGuide implicitRules 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. uri
ImplementationGuide _implicitRules Extensions for implicitRules Element
ImplementationGuide language The base language in which the resource is written. code
ImplementationGuide _language Extensions for language Element
ImplementationGuide text 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. Narrative
ImplementationGuide contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ImplementationGuide extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide url 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 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. uri
ImplementationGuide _url Extensions for url Element
ImplementationGuide version 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. string
ImplementationGuide _version Extensions for version Element
ImplementationGuide name 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. string
ImplementationGuide _name Extensions for name Element
ImplementationGuide title A short, descriptive, user-friendly title for the implementation guide. string
ImplementationGuide _title Extensions for title Element
ImplementationGuide status The status of this implementation guide. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
ImplementationGuide _status Extensions for status Element
ImplementationGuide experimental 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. boolean
ImplementationGuide _experimental Extensions for experimental Element
ImplementationGuide date The date (and optionally time) when the implementation guide 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 implementation guide changes. dateTime
ImplementationGuide _date Extensions for date Element
ImplementationGuide publisher The name of the organization or individual that published the implementation guide. string
ImplementationGuide _publisher Extensions for publisher Element
ImplementationGuide contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ImplementationGuide description A free text natural language description of the implementation guide from a consumer's perspective. markdown
ImplementationGuide _description Extensions for description Element
ImplementationGuide useContext 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. UsageContext
ImplementationGuide jurisdiction A legal or geographic region in which the implementation guide is intended to be used. CodeableConcept
ImplementationGuide copyright 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. markdown
ImplementationGuide _copyright Extensions for copyright Element
ImplementationGuide packageId 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. id
ImplementationGuide _packageId Extensions for packageId Element
ImplementationGuide license The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'. enum values:
not-open-source
0BSD
AAL
Abstyles
Adobe-2006
Adobe-Glyph
ADSL
AFL-1.1
AFL-1.2
AFL-2.0
AFL-2.1
AFL-3.0
Afmparse
AGPL-1.0-only
AGPL-1.0-or-later
AGPL-3.0-only
AGPL-3.0-or-later
Aladdin
AMDPLPA
AML
AMPAS
ANTLR-PD
Apache-1.0
Apache-1.1
Apache-2.0
APAFML
APL-1.0
APSL-1.0
APSL-1.1
APSL-1.2
APSL-2.0
Artistic-1.0-cl8
Artistic-1.0-Perl
Artistic-1.0
Artistic-2.0
Bahyph
Barr
Beerware
BitTorrent-1.0
BitTorrent-1.1
Borceux
BSD-1-Clause
BSD-2-Clause-FreeBSD
BSD-2-Clause-NetBSD
BSD-2-Clause-Patent
BSD-2-Clause
BSD-3-Clause-Attribution
BSD-3-Clause-Clear
BSD-3-Clause-LBNL
BSD-3-Clause-No-Nuclear-License-2014
BSD-3-Clause-No-Nuclear-License
BSD-3-Clause-No-Nuclear-Warranty
BSD-3-Clause
BSD-4-Clause-UC
BSD-4-Clause
BSD-Protection
BSD-Source-Code
BSL-1.0
bzip2-1.0.5
bzip2-1.0.6
Caldera
CATOSL-1.1
CC-BY-1.0
CC-BY-2.0
CC-BY-2.5
CC-BY-3.0
CC-BY-4.0
CC-BY-NC-1.0
CC-BY-NC-2.0
CC-BY-NC-2.5
CC-BY-NC-3.0
CC-BY-NC-4.0
CC-BY-NC-ND-1.0
CC-BY-NC-ND-2.0
CC-BY-NC-ND-2.5
CC-BY-NC-ND-3.0
CC-BY-NC-ND-4.0
CC-BY-NC-SA-1.0
CC-BY-NC-SA-2.0
CC-BY-NC-SA-2.5
CC-BY-NC-SA-3.0
CC-BY-NC-SA-4.0
CC-BY-ND-1.0
CC-BY-ND-2.0
CC-BY-ND-2.5
CC-BY-ND-3.0
CC-BY-ND-4.0
CC-BY-SA-1.0
CC-BY-SA-2.0
CC-BY-SA-2.5
CC-BY-SA-3.0
CC-BY-SA-4.0
CC0-1.0
CDDL-1.0
CDDL-1.1
CDLA-Permissive-1.0
CDLA-Sharing-1.0
CECILL-1.0
CECILL-1.1
CECILL-2.0
CECILL-2.1
CECILL-B
CECILL-C
ClArtistic
CNRI-Jython
CNRI-Python-GPL-Compatible
CNRI-Python
Condor-1.1
CPAL-1.0
CPL-1.0
CPOL-1.02
Crossword
CrystalStacker
CUA-OPL-1.0
Cube
curl
D-FSL-1.0
diffmark
DOC
Dotseqn
DSDP
dvipdfm
ECL-1.0
ECL-2.0
EFL-1.0
EFL-2.0
eGenix
Entessa
EPL-1.0
EPL-2.0
ErlPL-1.1
EUDatagrid
EUPL-1.0
EUPL-1.1
EUPL-1.2
Eurosym
Fair
Frameworx-1.0
FreeImage
FSFAP
FSFUL
FSFULLR
FTL
GFDL-1.1-only
GFDL-1.1-or-later
GFDL-1.2-only
GFDL-1.2-or-later
GFDL-1.3-only
GFDL-1.3-or-later
Giftware
GL2PS
Glide
Glulxe
gnuplot
GPL-1.0-only
GPL-1.0-or-later
GPL-2.0-only
GPL-2.0-or-later
GPL-3.0-only
GPL-3.0-or-later
gSOAP-1.3b
HaskellReport
HPND
IBM-pibs
ICU
IJG
ImageMagick
iMatix
Imlib2
Info-ZIP
Intel-ACPI
Intel
Interbase-1.0
IPA
IPL-1.0
ISC
JasPer-2.0
JSON
LAL-1.2
LAL-1.3
Latex2e
Leptonica
LGPL-2.0-only
LGPL-2.0-or-later
LGPL-2.1-only
LGPL-2.1-or-later
LGPL-3.0-only
LGPL-3.0-or-later
LGPLLR
Libpng
libtiff
LiLiQ-P-1.1
LiLiQ-R-1.1
LiLiQ-Rplus-1.1
Linux-OpenIB
LPL-1.0
LPL-1.02
LPPL-1.0
LPPL-1.1
LPPL-1.2
LPPL-1.3a
LPPL-1.3c
MakeIndex
MirOS
MIT-0
MIT-advertising
MIT-CMU
MIT-enna
MIT-feh
MIT
MITNFA
Motosoto
mpich2
MPL-1.0
MPL-1.1
MPL-2.0-no-copyleft-exception
MPL-2.0
MS-PL
MS-RL
MTLL
Multics
Mup
NASA-1.3
Naumen
NBPL-1.0
NCSA
Net-SNMP
NetCDF
Newsletr
NGPL
NLOD-1.0
NLPL
Nokia
NOSL
Noweb
NPL-1.0
NPL-1.1
NPOSL-3.0
NRL
NTP
OCCT-PL
OCLC-2.0
ODbL-1.0
OFL-1.0
OFL-1.1
OGTSL
OLDAP-1.1
OLDAP-1.2
OLDAP-1.3
OLDAP-1.4
OLDAP-2.0.1
OLDAP-2.0
OLDAP-2.1
OLDAP-2.2.1
OLDAP-2.2.2
OLDAP-2.2
OLDAP-2.3
OLDAP-2.4
OLDAP-2.5
OLDAP-2.6
OLDAP-2.7
OLDAP-2.8
OML
OpenSSL
OPL-1.0
OSET-PL-2.1
OSL-1.0
OSL-1.1
OSL-2.0
OSL-2.1
OSL-3.0
PDDL-1.0
PHP-3.0
PHP-3.01
Plexus
PostgreSQL
psfrag
psutils
Python-2.0
Qhull
QPL-1.0
Rdisc
RHeCos-1.1
RPL-1.1
RPL-1.5
RPSL-1.0
RSA-MD
RSCPL
Ruby
SAX-PD
Saxpath
SCEA
Sendmail
SGI-B-1.0
SGI-B-1.1
SGI-B-2.0
SimPL-2.0
SISSL-1.2
SISSL
Sleepycat
SMLNJ
SMPPL
SNIA
Spencer-86
Spencer-94
Spencer-99
SPL-1.0
SugarCRM-1.1.3
SWL
TCL
TCP-wrappers
TMate
TORQUE-1.1
TOSL
Unicode-DFS-2015
Unicode-DFS-2016
Unicode-TOU
Unlicense
UPL-1.0
Vim
VOSTROM
VSL-1.0
W3C-19980720
W3C-20150513
W3C
Watcom-1.0
Wsuipa
WTFPL
X11
Xerox
XFree86-1.1
xinetd
Xnet
xpp
XSkat
YPL-1.0
YPL-1.1
Zed
Zend-2.0
Zimbra-1.3
Zimbra-1.4
zlib-acknowledgement
Zlib
ZPL-1.1
ZPL-2.0
ZPL-2.1
ImplementationGuide _license Extensions for license Element
ImplementationGuide fhirVersion 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.0.0. for this version. enum values:
0.01
0.05
0.06
0.11
0.0.80
0.0.81
0.0.82
0.4.0
0.5.0
1.0.0
1.0.1
1.0.2
1.1.0
1.4.0
1.6.0
1.8.0
3.0.0
3.0.1
3.3.0
3.5.0
4.0.0
ImplementationGuide _fhirVersion Extensions for fhirVersion Element
ImplementationGuide dependsOn Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides. ImplementationGuide_DependsOn
ImplementationGuide global A set of profiles that all resources covered by this implementation guide must conform to. ImplementationGuide_Global
ImplementationGuide definition The information needed by an IG publisher tool to publish the whole implementation guide. ImplementationGuide_Definition
ImplementationGuide manifest Information about an assembled implementation guide, created by the publication tooling. ImplementationGuide_Manifest
ImplementationGuide_Definition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Definition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Definition modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Definition grouping A logical group of resources. Logical groups can be used when building pages. ImplementationGuide_Grouping
ImplementationGuide_Definition resource 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_Resource
ImplementationGuide_Definition page A page / section in the implementation guide. The root page is the implementation guide home page. ImplementationGuide_Page
ImplementationGuide_Definition parameter Defines how IG is built by tools. ImplementationGuide_Parameter
ImplementationGuide_Definition template A template for building resources. ImplementationGuide_Template
ImplementationGuide_DependsOn id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_DependsOn extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_DependsOn modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_DependsOn uri A canonical reference to the Implementation guide for the dependency. canonical
ImplementationGuide_DependsOn packageId The NPM package name for the Implementation Guide that this IG depends on. id
ImplementationGuide_DependsOn _packageId Extensions for packageId Element
ImplementationGuide_DependsOn version The version of the IG that is depended on, when the correct version is required to understand the IG correctly. string
ImplementationGuide_DependsOn _version Extensions for version Element
ImplementationGuide_Global id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Global extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Global modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Global type The type of resource that all instances must conform to. code
ImplementationGuide_Global _type Extensions for type Element
ImplementationGuide_Global profile A reference to the profile that all instances must conform to. canonical
ImplementationGuide_Grouping id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Grouping extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Grouping modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Grouping name The human-readable title to display for the package of resources when rendering the implementation guide. string
ImplementationGuide_Grouping _name Extensions for name Element
ImplementationGuide_Grouping description Human readable text describing the package. string
ImplementationGuide_Grouping _description Extensions for description Element
ImplementationGuide_Manifest id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Manifest extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Manifest modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Manifest rendering A pointer to official web page, PDF or other rendering of the implementation guide. url
ImplementationGuide_Manifest _rendering Extensions for rendering Element
ImplementationGuide_Manifest resource 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_Resource1
ImplementationGuide_Manifest page Information about a page within the IG. ImplementationGuide_Page1
ImplementationGuide_Manifest image Indicates a relative path to an image that exists within the IG. string
ImplementationGuide_Manifest _image Extensions for image Element
ImplementationGuide_Manifest other 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. string
ImplementationGuide_Manifest _other Extensions for other Element
ImplementationGuide_Page id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Page extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Page modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Page nameUrl The source address for the page. notDefined
ImplementationGuide_Page _nameUrl Extensions for nameUrl Element
ImplementationGuide_Page nameReference The source address for the page. Reference
ImplementationGuide_Page title A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc. string
ImplementationGuide_Page _title Extensions for title Element
ImplementationGuide_Page generation A code that indicates how the page is generated. enum values:
html
markdown
xml
generated
ImplementationGuide_Page _generation Extensions for generation Element
ImplementationGuide_Page page Nested Pages/Sections under this page. ImplementationGuide_Page
ImplementationGuide_Page1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Page1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Page1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Page1 name Relative path to the page. string
ImplementationGuide_Page1 _name Extensions for name Element
ImplementationGuide_Page1 title Label for the page intended for human display. string
ImplementationGuide_Page1 _title Extensions for title Element
ImplementationGuide_Page1 anchor The name of an anchor available on the page. string
ImplementationGuide_Page1 _anchor Extensions for anchor Element
ImplementationGuide_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Parameter code apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template. enum values:
apply
path-resource
path-pages
path-tx-cache
expansion-parameter
rule-broken-links
generate-xml
generate-json
generate-turtle
html-template
ImplementationGuide_Parameter _code Extensions for code Element
ImplementationGuide_Parameter value Value for named type. string
ImplementationGuide_Parameter _value Extensions for value Element
ImplementationGuide_Resource id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Resource extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Resource modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Resource reference Where this resource is found. Reference
ImplementationGuide_Resource fhirVersion 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. enum values:
0.01
0.05
0.06
0.11
0.0.80
0.0.81
0.0.82
0.4.0
0.5.0
1.0.0
1.0.1
1.0.2
1.1.0
1.4.0
1.6.0
1.8.0
3.0.0
3.0.1
3.3.0
3.5.0
4.0.0
ImplementationGuide_Resource _fhirVersion Extensions for fhirVersion Element
ImplementationGuide_Resource name 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). string
ImplementationGuide_Resource _name Extensions for name Element
ImplementationGuide_Resource description A description of the reason that a resource has been included in the implementation guide. string
ImplementationGuide_Resource _description Extensions for description Element
ImplementationGuide_Resource exampleBoolean If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile. notDefined
ImplementationGuide_Resource _exampleBoolean Extensions for exampleBoolean Element
ImplementationGuide_Resource exampleCanonical If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile. notDefined
ImplementationGuide_Resource _exampleCanonical Extensions for exampleCanonical Element
ImplementationGuide_Resource groupingId Reference to the id of the grouping this resource appears in. id
ImplementationGuide_Resource _groupingId Extensions for groupingId Element
ImplementationGuide_Resource1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Resource1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Resource1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Resource1 reference Where this resource is found. Reference
ImplementationGuide_Resource1 exampleBoolean If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile. notDefined
ImplementationGuide_Resource1 _exampleBoolean Extensions for exampleBoolean Element
ImplementationGuide_Resource1 exampleCanonical If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile. notDefined
ImplementationGuide_Resource1 _exampleCanonical Extensions for exampleCanonical Element
ImplementationGuide_Resource1 relativePath The relative path for primary page for this resource within the IG. url
ImplementationGuide_Resource1 _relativePath Extensions for relativePath Element
ImplementationGuide_Template id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ImplementationGuide_Template extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ImplementationGuide_Template modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ImplementationGuide_Template code Type of template specified. code
ImplementationGuide_Template _code Extensions for code Element
ImplementationGuide_Template source The source location for the template. string
ImplementationGuide_Template _source Extensions for source Element
ImplementationGuide_Template scope The scope in which the template applies. string
ImplementationGuide_Template _scope Extensions for scope Element
InsurancePlan resourceType This is a InsurancePlan resource InsurancePlan
InsurancePlan id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
InsurancePlan meta 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. Meta
InsurancePlan implicitRules 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. uri
InsurancePlan _implicitRules Extensions for implicitRules Element
InsurancePlan language The base language in which the resource is written. code
InsurancePlan _language Extensions for language Element
InsurancePlan text 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. Narrative
InsurancePlan contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
InsurancePlan extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan identifier Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server. Identifier
InsurancePlan status The current state of the health insurance product. enum values:
draft
active
retired
unknown
InsurancePlan _status Extensions for status Element
InsurancePlan type The kind of health insurance product. CodeableConcept
InsurancePlan name Official name of the health insurance product as designated by the owner. string
InsurancePlan _name Extensions for name Element
InsurancePlan alias A list of alternate names that the product is known as, or was known as in the past. string
InsurancePlan _alias Extensions for alias Element
InsurancePlan period The period of time that the health insurance product is available. Period
InsurancePlan ownedBy 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'. Reference
InsurancePlan administeredBy An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner. Reference
InsurancePlan coverageArea The geographic region in which a health insurance product's benefits apply. Reference
InsurancePlan contact The contact for the health insurance product for a certain purpose. InsurancePlan_Contact
InsurancePlan endpoint The technical endpoints providing access to services operated for the health insurance product. Reference
InsurancePlan network Reference to the network included in the health insurance product. Reference
InsurancePlan coverage Details about the coverage offered by the insurance product. InsurancePlan_Coverage
InsurancePlan plan Details about an insurance plan. InsurancePlan_Plan
InsurancePlan_Benefit id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_Benefit extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_Benefit modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_Benefit type Type of benefit (primary care; speciality care; inpatient; outpatient). CodeableConcept
InsurancePlan_Benefit requirement The referral requirements to have access/coverage for this benefit. string
InsurancePlan_Benefit _requirement Extensions for requirement Element
InsurancePlan_Benefit limit The specific limits on the benefit. InsurancePlan_Limit
InsurancePlan_Benefit1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_Benefit1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_Benefit1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_Benefit1 type Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care). CodeableConcept
InsurancePlan_Benefit1 cost List of the costs associated with a specific benefit. InsurancePlan_Cost
InsurancePlan_Contact id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_Contact extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_Contact modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_Contact purpose Indicates a purpose for which the contact can be reached. CodeableConcept
InsurancePlan_Contact name A name associated with the contact. HumanName
InsurancePlan_Contact telecom A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. ContactPoint
InsurancePlan_Contact address Visiting or postal addresses for the contact. Address
InsurancePlan_Cost id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_Cost extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_Cost modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_Cost type Type of cost (copay; individual cap; family cap; coinsurance; deductible). CodeableConcept
InsurancePlan_Cost applicability Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other). CodeableConcept
InsurancePlan_Cost qualifiers Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA). CodeableConcept
InsurancePlan_Cost value The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance). Quantity
InsurancePlan_Coverage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_Coverage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_Coverage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_Coverage type Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health). CodeableConcept
InsurancePlan_Coverage network Reference to the network that providing the type of coverage. Reference
InsurancePlan_Coverage benefit Specific benefits under this type of coverage. InsurancePlan_Benefit
InsurancePlan_GeneralCost id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_GeneralCost extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_GeneralCost modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_GeneralCost type Type of cost. CodeableConcept
InsurancePlan_GeneralCost groupSize Number of participants enrolled in the plan. positiveInt
InsurancePlan_GeneralCost _groupSize Extensions for groupSize Element
InsurancePlan_GeneralCost cost Value of the cost. Money
InsurancePlan_GeneralCost comment Additional information about the general costs associated with this plan. string
InsurancePlan_GeneralCost _comment Extensions for comment Element
InsurancePlan_Limit id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_Limit extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_Limit modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_Limit value The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses. Quantity
InsurancePlan_Limit code The specific limit on the benefit. CodeableConcept
InsurancePlan_Plan id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_Plan extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_Plan modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_Plan identifier Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server. Identifier
InsurancePlan_Plan type Type of plan. For example, "Platinum" or "High Deductable". CodeableConcept
InsurancePlan_Plan coverageArea The geographic region in which a health insurance plan's benefits apply. Reference
InsurancePlan_Plan network Reference to the network that providing the type of coverage. Reference
InsurancePlan_Plan generalCost Overall costs associated with the plan. InsurancePlan_GeneralCost
InsurancePlan_Plan specificCost Costs associated with the coverage provided by the product. InsurancePlan_SpecificCost
InsurancePlan_SpecificCost id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
InsurancePlan_SpecificCost extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
InsurancePlan_SpecificCost modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
InsurancePlan_SpecificCost category General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health). CodeableConcept
InsurancePlan_SpecificCost benefit List of the specific benefits under this category of benefit. InsurancePlan_Benefit1
Invoice resourceType This is a Invoice resource Invoice
Invoice id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Invoice meta 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. Meta
Invoice implicitRules 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. uri
Invoice _implicitRules Extensions for implicitRules Element
Invoice language The base language in which the resource is written. code
Invoice _language Extensions for language Element
Invoice text 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. Narrative
Invoice contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Invoice extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Invoice modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Invoice identifier Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. Identifier
Invoice status The current state of the Invoice. enum values:
draft
issued
balanced
cancelled
entered-in-error
Invoice _status Extensions for status Element
Invoice cancelledReason In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). string
Invoice _cancelledReason Extensions for cancelledReason Element
Invoice type Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). CodeableConcept
Invoice subject The individual or set of individuals receiving the goods and services billed in this invoice. Reference
Invoice recipient The individual or Organization responsible for balancing of this invoice. Reference
Invoice date Date/time(s) of when this Invoice was posted. dateTime
Invoice _date Extensions for date Element
Invoice participant Indicates who or what performed or participated in the charged service. Invoice_Participant
Invoice issuer The organizationissuing the Invoice. Reference
Invoice account Account which is supposed to be balanced with this Invoice. Reference
Invoice lineItem Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource. Invoice_LineItem
Invoice totalPriceComponent 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. Invoice_PriceComponent
Invoice totalNet Invoice total , taxes excluded. Money
Invoice totalGross Invoice total, tax included. Money
Invoice paymentTerms Payment details such as banking details, period of payment, deductibles, methods of payment. markdown
Invoice _paymentTerms Extensions for paymentTerms Element
Invoice note Comments made about the invoice by the issuer, subject, or other participants. Annotation
Invoice_LineItem id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Invoice_LineItem extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Invoice_LineItem modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Invoice_LineItem sequence Sequence in which the items appear on the invoice. positiveInt
Invoice_LineItem _sequence Extensions for sequence Element
Invoice_LineItem chargeItemReference 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. Reference
Invoice_LineItem chargeItemCodeableConcept 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. CodeableConcept
Invoice_LineItem priceComponent 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. Invoice_PriceComponent
Invoice_Participant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Invoice_Participant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Invoice_Participant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Invoice_Participant role 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. CodeableConcept
Invoice_Participant actor The device, practitioner, etc. who performed or participated in the service. Reference
Invoice_PriceComponent id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Invoice_PriceComponent extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Invoice_PriceComponent modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Invoice_PriceComponent type This code identifies the type of the component. enum values:
base
surcharge
deduction
discount
tax
informational
Invoice_PriceComponent _type Extensions for type Element
Invoice_PriceComponent code A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. CodeableConcept
Invoice_PriceComponent factor The factor that has been applied on the base price for calculating this component. decimal
Invoice_PriceComponent _factor Extensions for factor Element
Invoice_PriceComponent amount The amount calculated for this component. Money
Library resourceType This is a Library resource Library
Library id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Library meta 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. Meta
Library implicitRules 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. uri
Library _implicitRules Extensions for implicitRules Element
Library language The base language in which the resource is written. code
Library _language Extensions for language Element
Library text 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. Narrative
Library contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Library extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Library modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Library url 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 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. uri
Library _url Extensions for url Element
Library identifier 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. Identifier
Library version 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. string
Library _version Extensions for version Element
Library name 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. string
Library _name Extensions for name Element
Library title A short, descriptive, user-friendly title for the library. string
Library _title Extensions for title Element
Library subtitle An explanatory or alternate title for the library giving additional information about its content. string
Library _subtitle Extensions for subtitle Element
Library status The status of this library. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
Library _status Extensions for status Element
Library experimental 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. boolean
Library _experimental Extensions for experimental Element
Library type Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition. CodeableConcept
Library subjectCodeableConcept A code or group definition that describes the intended subject of the contents of the library. CodeableConcept
Library subjectReference A code or group definition that describes the intended subject of the contents of the library. Reference
Library date The date (and optionally time) when the library 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 library changes. dateTime
Library _date Extensions for date Element
Library publisher The name of the organization or individual that published the library. string
Library _publisher Extensions for publisher Element
Library contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
Library description A free text natural language description of the library from a consumer's perspective. markdown
Library _description Extensions for description Element
Library useContext 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. UsageContext
Library jurisdiction A legal or geographic region in which the library is intended to be used. CodeableConcept
Library purpose Explanation of why this library is needed and why it has been designed as it has. markdown
Library _purpose Extensions for purpose Element
Library usage A detailed description of how the library is used from a clinical perspective. string
Library _usage Extensions for usage Element
Library copyright 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. markdown
Library _copyright Extensions for copyright Element
Library approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
Library _approvalDate Extensions for approvalDate Element
Library lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
Library _lastReviewDate Extensions for lastReviewDate Element
Library effectivePeriod The period during which the library content was or is planned to be in active use. Period
Library topic 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. CodeableConcept
Library author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
Library editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
Library reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
Library endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
Library relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
Library parameter The parameter element defines parameters used by the library. ParameterDefinition
Library dataRequirement Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library. DataRequirement
Library content 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. Attachment
Linkage resourceType This is a Linkage resource Linkage
Linkage id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Linkage meta 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. Meta
Linkage implicitRules 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. uri
Linkage _implicitRules Extensions for implicitRules Element
Linkage language The base language in which the resource is written. code
Linkage _language Extensions for language Element
Linkage text 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. Narrative
Linkage contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Linkage extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Linkage modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Linkage active Indicates whether the asserted set of linkages are considered to be "in effect". boolean
Linkage _active Extensions for active Element
Linkage author 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. Reference
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
Linkage_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Linkage_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Linkage_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Linkage_Item type Distinguishes which item is "source of truth" (if any) and which items are no longer considered to be current representations. enum values:
source
alternate
historical
Linkage_Item _type Extensions for type Element
Linkage_Item resource The resource instance being linked as part of the group. Reference
List resourceType This is a List resource List
List id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
List meta 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. Meta
List implicitRules 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. uri
List _implicitRules Extensions for implicitRules Element
List language The base language in which the resource is written. code
List _language Extensions for language Element
List text 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. Narrative
List contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
List extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
List modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
List identifier Identifier for the List assigned for business purposes outside the context of FHIR. Identifier
List status Indicates the current state of this list. enum values:
current
retired
entered-in-error
List _status Extensions for status Element
List mode 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. enum values:
working
snapshot
changes
List _mode Extensions for mode Element
List title A label for the list assigned by the author. string
List _title Extensions for title Element
List code This code defines the purpose of the list - why it was created. CodeableConcept
List subject The common subject (or patient) of the resources that are in the list if there is one. Reference
List encounter The encounter that is the context in which this list was created. Reference
List date The date that the list was prepared. dateTime
List _date Extensions for date Element
List source 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. Reference
List orderedBy What order applies to the items in the list. CodeableConcept
List note Comments that apply to the overall list. Annotation
List entry Entries in this list. List_Entry
List emptyReason If the list is empty, why the list is empty. CodeableConcept
List_Entry id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
List_Entry extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
List_Entry modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
List_Entry flag The flag allows the system constructing the list to indicate the role and significance of the item in the list. CodeableConcept
List_Entry deleted True if this item is marked as deleted in the list. boolean
List_Entry _deleted Extensions for deleted Element
List_Entry date When this item was added to the list. dateTime
List_Entry _date Extensions for date Element
List_Entry item A reference to the actual resource from which data was derived. Reference
Location resourceType This is a Location resource Location
Location id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Location meta 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. Meta
Location implicitRules 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. uri
Location _implicitRules Extensions for implicitRules Element
Location language The base language in which the resource is written. code
Location _language Extensions for language Element
Location text 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. Narrative
Location contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Location extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Location modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Location identifier Unique code or number identifying the location to its users. Identifier
Location status 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. enum values:
active
suspended
inactive
Location _status Extensions for status Element
Location operationalStatus 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. Coding
Location name Name of the location as used by humans. Does not need to be unique. string
Location _name Extensions for name Element
Location alias A list of alternate names that the location is known as, or was known as, in the past. string
Location _alias Extensions for alias Element
Location description Description of the Location, which helps in finding or referencing the place. string
Location _description Extensions for description Element
Location mode Indicates whether a resource instance represents a specific location or a class of locations. enum values:
instance
kind
Location _mode Extensions for mode Element
Location type Indicates the type of function performed at the location. CodeableConcept
Location telecom The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. ContactPoint
Location address Physical location. Address
Location physicalType Physical form of the location, e.g. building, room, vehicle, road. CodeableConcept
Location position The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Location_Position
Location managingOrganization The organization responsible for the provisioning and upkeep of the location. Reference
Location partOf Another Location of which this Location is physically a part of. Reference
Location hoursOfOperation What days/times during a week is this location usually open. Location_HoursOfOperation
Location availabilityExceptions A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times. string
Location _availabilityExceptions Extensions for availabilityExceptions Element
Location endpoint Technical endpoints providing access to services operated for the location. Reference
Location_HoursOfOperation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Location_HoursOfOperation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Location_HoursOfOperation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Location_HoursOfOperation daysOfWeek Indicates which days of the week are available between the start and end Times. code
Location_HoursOfOperation _daysOfWeek Extensions for daysOfWeek Element
Location_HoursOfOperation allDay The Location is open all day. boolean
Location_HoursOfOperation _allDay Extensions for allDay Element
Location_HoursOfOperation openingTime Time that the Location opens. time
Location_HoursOfOperation _openingTime Extensions for openingTime Element
Location_HoursOfOperation closingTime Time that the Location closes. time
Location_HoursOfOperation _closingTime Extensions for closingTime Element
Location_Position id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Location_Position extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Location_Position modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Location_Position longitude Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). decimal
Location_Position _longitude Extensions for longitude Element
Location_Position latitude Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). decimal
Location_Position _latitude Extensions for latitude Element
Location_Position altitude Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). decimal
Location_Position _altitude Extensions for altitude Element
MarketingStatus id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MarketingStatus extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MarketingStatus modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MarketingStatus country The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements. CodeableConcept
MarketingStatus jurisdiction Where a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified. CodeableConcept
MarketingStatus status This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples. CodeableConcept
MarketingStatus dateRange The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain. Period
MarketingStatus restoreDate The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain. dateTime
MarketingStatus _restoreDate Extensions for restoreDate Element
Measure resourceType This is a Measure resource Measure
Measure id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Measure meta 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. Meta
Measure implicitRules 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. uri
Measure _implicitRules Extensions for implicitRules Element
Measure language The base language in which the resource is written. code
Measure _language Extensions for language Element
Measure text 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. Narrative
Measure contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Measure extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Measure modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Measure url 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 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. uri
Measure _url Extensions for url Element
Measure identifier 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. Identifier
Measure version 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. string
Measure _version Extensions for version Element
Measure name 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. string
Measure _name Extensions for name Element
Measure title A short, descriptive, user-friendly title for the measure. string
Measure _title Extensions for title Element
Measure subtitle An explanatory or alternate title for the measure giving additional information about its content. string
Measure _subtitle Extensions for subtitle Element
Measure status The status of this measure. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
Measure _status Extensions for status Element
Measure experimental 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. boolean
Measure _experimental Extensions for experimental Element
Measure subjectCodeableConcept 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. CodeableConcept
Measure subjectReference 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. Reference
Measure date The date (and optionally time) when the measure 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 measure changes. dateTime
Measure _date Extensions for date Element
Measure publisher The name of the organization or individual that published the measure. string
Measure _publisher Extensions for publisher Element
Measure contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
Measure description A free text natural language description of the measure from a consumer's perspective. markdown
Measure _description Extensions for description Element
Measure useContext 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. UsageContext
Measure jurisdiction A legal or geographic region in which the measure is intended to be used. CodeableConcept
Measure purpose Explanation of why this measure is needed and why it has been designed as it has. markdown
Measure _purpose Extensions for purpose Element
Measure usage A detailed description, from a clinical perspective, of how the measure is used. string
Measure _usage Extensions for usage Element
Measure copyright 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. markdown
Measure _copyright Extensions for copyright Element
Measure approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
Measure _approvalDate Extensions for approvalDate Element
Measure lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
Measure _lastReviewDate Extensions for lastReviewDate Element
Measure effectivePeriod The period during which the measure content was or is planned to be in active use. Period
Measure topic 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. CodeableConcept
Measure author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
Measure editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
Measure reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
Measure endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
Measure relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
Measure library A reference to a Library resource containing the formal logic used by the measure. canonical
Measure disclaimer Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure. markdown
Measure _disclaimer Extensions for disclaimer Element
Measure scoring 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. CodeableConcept
Measure compositeScoring If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. CodeableConcept
Measure type 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. CodeableConcept
Measure riskAdjustment 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. string
Measure _riskAdjustment Extensions for riskAdjustment Element
Measure rateAggregation Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. string
Measure _rateAggregation Extensions for rateAggregation Element
Measure rationale Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence. markdown
Measure _rationale Extensions for rationale Element
Measure clinicalRecommendationStatement Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure. markdown
Measure _clinicalRecommendationStatement Extensions for clinicalRecommendationStatement Element
Measure improvementNotation 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). CodeableConcept
Measure definition Provides a description of an individual term used within the measure. markdown
Measure _definition Extensions for definition Element
Measure guidance Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure. markdown
Measure _guidance Extensions for guidance Element
Measure group A group of population criteria for the measure. Measure_Group
Measure supplementalData 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. Measure_SupplementalData
MeasureReport resourceType This is a MeasureReport resource MeasureReport
MeasureReport id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MeasureReport meta 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. Meta
MeasureReport implicitRules 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. uri
MeasureReport _implicitRules Extensions for implicitRules Element
MeasureReport language The base language in which the resource is written. code
MeasureReport _language Extensions for language Element
MeasureReport text 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. Narrative
MeasureReport contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MeasureReport extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MeasureReport modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MeasureReport identifier 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. Identifier
MeasureReport status The MeasureReport status. No data will be available until the MeasureReport status is complete. enum values:
complete
pending
error
MeasureReport _status Extensions for status Element
MeasureReport type 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. enum values:
individual
subject-list
summary
data-collection
MeasureReport _type Extensions for type Element
MeasureReport measure A reference to the Measure that was calculated to produce this report. canonical
MeasureReport subject Optional subject identifying the individual or individuals the report is for. Reference
MeasureReport date The date this measure report was generated. dateTime
MeasureReport _date Extensions for date Element
MeasureReport reporter The individual, location, or organization that is reporting the data. Reference
MeasureReport period The reporting period for which the report was calculated. Period
MeasureReport improvementNotation Whether improvement in the measure is noted by an increase or decrease in the measure score. CodeableConcept
MeasureReport group The results of the calculation, one for each population group in the measure. MeasureReport_Group
MeasureReport evaluatedResource A reference to a Bundle containing the Resources that were used in the calculation of this measure. Reference
MeasureReport_Component id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MeasureReport_Component extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MeasureReport_Component modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MeasureReport_Component code The code for the stratum component value. CodeableConcept
MeasureReport_Component value The stratum component value. CodeableConcept
MeasureReport_Group id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MeasureReport_Group extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MeasureReport_Group modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MeasureReport_Group code The meaning of the population group as defined in the measure definition. CodeableConcept
MeasureReport_Group population The populations that make up the population group, one for each type of population appropriate for the measure. MeasureReport_Population
MeasureReport_Group measureScore 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. Quantity
MeasureReport_Group stratifier When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure. MeasureReport_Stratifier
MeasureReport_Population id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MeasureReport_Population extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MeasureReport_Population modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MeasureReport_Population code The type of the population. CodeableConcept
MeasureReport_Population count The number of members of the population. integer
MeasureReport_Population _count Extensions for count Element
MeasureReport_Population subjectResults This element refers to a List of subject level MeasureReport resources, one for each subject in this population. Reference
MeasureReport_Population1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MeasureReport_Population1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MeasureReport_Population1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MeasureReport_Population1 code The type of the population. CodeableConcept
MeasureReport_Population1 count The number of members of the population in this stratum. integer
MeasureReport_Population1 _count Extensions for count Element
MeasureReport_Population1 subjectResults This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum. Reference
MeasureReport_Stratifier id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MeasureReport_Stratifier extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MeasureReport_Stratifier modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MeasureReport_Stratifier code The meaning of this stratifier, as defined in the measure definition. CodeableConcept
MeasureReport_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_Stratum
MeasureReport_Stratum id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MeasureReport_Stratum extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MeasureReport_Stratum modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MeasureReport_Stratum value The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique. CodeableConcept
MeasureReport_Stratum component A stratifier component value. MeasureReport_Component
MeasureReport_Stratum population The populations that make up the stratum, one for each type of population appropriate to the measure. MeasureReport_Population1
MeasureReport_Stratum measureScore 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. Quantity
Measure_Component id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Measure_Component extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Measure_Component modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Measure_Component code 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. CodeableConcept
Measure_Component description The human readable description of this stratifier criteria component. string
Measure_Component _description Extensions for description Element
Measure_Component criteria 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. Expression
Measure_Group id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Measure_Group extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Measure_Group modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Measure_Group code 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. CodeableConcept
Measure_Group description The human readable description of this population group. string
Measure_Group _description Extensions for description Element
Measure_Group population A population criteria for the measure. Measure_Population
Measure_Group stratifier 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_Stratifier
Measure_Population id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Measure_Population extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Measure_Population modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Measure_Population code The type of population criteria. CodeableConcept
Measure_Population description The human readable description of this population criteria. string
Measure_Population _description Extensions for description Element
Measure_Population criteria An expression that specifies the criteria for the population, typically the name of an expression in a library. Expression
Measure_Stratifier id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Measure_Stratifier extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Measure_Stratifier modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Measure_Stratifier code 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. CodeableConcept
Measure_Stratifier description The human readable description of this stratifier criteria. string
Measure_Stratifier _description Extensions for description Element
Measure_Stratifier criteria 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. Expression
Measure_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. Measure_Component
Measure_SupplementalData id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Measure_SupplementalData extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Measure_SupplementalData modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Measure_SupplementalData code 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. CodeableConcept
Measure_SupplementalData usage 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. CodeableConcept
Measure_SupplementalData description The human readable description of this supplemental data. string
Measure_SupplementalData _description Extensions for description Element
Measure_SupplementalData criteria 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. Expression
Media resourceType This is a Media resource Media
Media id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Media meta 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. Meta
Media implicitRules 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. uri
Media _implicitRules Extensions for implicitRules Element
Media language The base language in which the resource is written. code
Media _language Extensions for language Element
Media text 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. Narrative
Media contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Media extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Media modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Media identifier Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. Identifier
Media basedOn A procedure that is fulfilled in whole or in part by the creation of this media. Reference
Media partOf A larger event of which this particular event is a component or step. Reference
Media status The current state of the {{title}}. code
Media _status Extensions for status Element
Media type A code that classifies whether the media is an image, video or audio recording or some other media category. CodeableConcept
Media modality Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality. CodeableConcept
Media view The name of the imaging view e.g. Lateral or Antero-posterior (AP). CodeableConcept
Media subject Who/What this Media is a record of. Reference
Media encounter The encounter that establishes the context for this media. Reference
Media createdDateTime The date and time(s) at which the media was collected. notDefined
Media _createdDateTime Extensions for createdDateTime Element
Media createdPeriod The date and time(s) at which the media was collected. Period
Media issued The date and time this version of the media was made available to providers, typically after having been reviewed. instant
Media _issued Extensions for issued Element
Media operator The person who administered the collection of the image. Reference
Media reasonCode Describes why the event occurred in coded or textual form. CodeableConcept
Media bodySite Indicates the site on the subject's body where the observation was made (i.e. the target site). CodeableConcept
Media deviceName The name of the device / manufacturer of the device that was used to make the recording. string
Media _deviceName Extensions for deviceName Element
Media device The device used to collect the media. Reference
Media height Height of the image in pixels (photo/video). positiveInt
Media _height Extensions for height Element
Media width Width of the image in pixels (photo/video). positiveInt
Media _width Extensions for width Element
Media frames 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. positiveInt
Media _frames Extensions for frames Element
Media duration The duration of the recording in seconds - for audio and video. decimal
Media _duration Extensions for duration Element
Media content The actual content of the media - inline or by direct reference to the media source file. Attachment
Media note Comments made about the media by the performer, subject or other participants. Annotation
Medication resourceType This is a Medication resource Medication
Medication id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Medication meta 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. Meta
Medication implicitRules 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. uri
Medication _implicitRules Extensions for implicitRules Element
Medication language The base language in which the resource is written. code
Medication _language Extensions for language Element
Medication text 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. Narrative
Medication contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Medication extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Medication modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Medication identifier Business identifier for this medication. Identifier
Medication code 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. CodeableConcept
Medication status A code to indicate if the medication is in active use. code
Medication _status Extensions for status Element
Medication manufacturer Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. Reference
Medication form Describes the form of the item. Powder; tablets; capsule. CodeableConcept
Medication amount Specific amount of the drug in the packaged 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.). Ratio
Medication ingredient Identifies a particular constituent of interest in the product. Medication_Ingredient
Medication batch Information that only applies to packages (not products). Medication_Batch
MedicationAdministration resourceType This is a MedicationAdministration resource MedicationAdministration
MedicationAdministration id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicationAdministration meta 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. Meta
MedicationAdministration implicitRules 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. uri
MedicationAdministration _implicitRules Extensions for implicitRules Element
MedicationAdministration language The base language in which the resource is written. code
MedicationAdministration _language Extensions for language Element
MedicationAdministration text 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. Narrative
MedicationAdministration contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicationAdministration extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationAdministration modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationAdministration identifier 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. Identifier
MedicationAdministration instantiates A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event. uri
MedicationAdministration _instantiates Extensions for instantiates Element
MedicationAdministration partOf A larger event of which this particular event is a component or step. Reference
MedicationAdministration status 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. code
MedicationAdministration _status Extensions for status Element
MedicationAdministration statusReason A code indicating why the administration was not performed. CodeableConcept
MedicationAdministration category Indicates where the medication is expected to be consumed or administered. CodeableConcept
MedicationAdministration medicationCodeableConcept 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. CodeableConcept
MedicationAdministration medicationReference 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. Reference
MedicationAdministration subject The person or animal or group receiving the medication. Reference
MedicationAdministration context The visit, admission, or other contact between patient and health care provider during which the medication administration was performed. Reference
MedicationAdministration supportingInformation Additional information (for example, patient height and weight) that supports the administration of the medication. Reference
MedicationAdministration effectiveDateTime A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. notDefined
MedicationAdministration _effectiveDateTime Extensions for effectiveDateTime Element
MedicationAdministration effectivePeriod A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. Period
MedicationAdministration performer Indicates who or what performed the medication administration and how they were involved. MedicationAdministration_Performer
MedicationAdministration reasonCode A code indicating why the medication was given. CodeableConcept
MedicationAdministration reasonReference Condition or observation that supports why the medication was administered. Reference
MedicationAdministration request The original request, instruction or authority to perform the administration. Reference
MedicationAdministration device The device used in administering the medication to the patient. For example, a particular infusion pump. Reference
MedicationAdministration note Extra information about the medication administration that is not conveyed by the other attributes. Annotation
MedicationAdministration dosage Describes the medication dosage information details e.g. dose, rate, site, route, etc. MedicationAdministration_Dosage
MedicationAdministration eventHistory A summary of the events of interest that have occurred, such as when the administration was verified. Reference
MedicationAdministration_Dosage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationAdministration_Dosage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationAdministration_Dosage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationAdministration_Dosage text 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. string
MedicationAdministration_Dosage _text Extensions for text Element
MedicationAdministration_Dosage site A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". CodeableConcept
MedicationAdministration_Dosage route A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc. CodeableConcept
MedicationAdministration_Dosage method 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. CodeableConcept
MedicationAdministration_Dosage dose 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. Quantity
MedicationAdministration_Dosage rateRatio 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. Ratio
MedicationAdministration_Dosage rateQuantity 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. Quantity
MedicationAdministration_Performer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationAdministration_Performer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationAdministration_Performer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationAdministration_Performer function Distinguishes the type of involvement of the performer in the medication administration. CodeableConcept
MedicationAdministration_Performer actor Indicates who or what performed the medication administration. Reference
MedicationDispense resourceType This is a MedicationDispense resource MedicationDispense
MedicationDispense id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicationDispense meta 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. Meta
MedicationDispense implicitRules 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. uri
MedicationDispense _implicitRules Extensions for implicitRules Element
MedicationDispense language The base language in which the resource is written. code
MedicationDispense _language Extensions for language Element
MedicationDispense text 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. Narrative
MedicationDispense contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicationDispense extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationDispense modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationDispense identifier 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. Identifier
MedicationDispense partOf The procedure that trigger the dispense. Reference
MedicationDispense status A code specifying the state of the set of dispense events. code
MedicationDispense _status Extensions for status Element
MedicationDispense statusReasonCodeableConcept Indicates the reason why a dispense was not performed. CodeableConcept
MedicationDispense statusReasonReference Indicates the reason why a dispense was not performed. Reference
MedicationDispense category Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). CodeableConcept
MedicationDispense medicationCodeableConcept 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. CodeableConcept
MedicationDispense medicationReference 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. Reference
MedicationDispense subject A link to a resource representing the person or the group to whom the medication will be given. Reference
MedicationDispense context The encounter or episode of care that establishes the context for this event. Reference
MedicationDispense supportingInformation Additional information that supports the medication being dispensed. Reference
MedicationDispense performer Indicates who or what performed the event. MedicationDispense_Performer
MedicationDispense location The principal physical location where the dispense was performed. Reference
MedicationDispense authorizingPrescription Indicates the medication order that is being dispensed against. Reference
MedicationDispense type Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. CodeableConcept
MedicationDispense quantity The amount of medication that has been dispensed. Includes unit of measure. Quantity
MedicationDispense daysSupply The amount of medication expressed as a timing amount. Quantity
MedicationDispense whenPrepared The time when the dispensed product was packaged and reviewed. dateTime
MedicationDispense _whenPrepared Extensions for whenPrepared Element
MedicationDispense whenHandedOver The time the dispensed product was provided to the patient or their representative. dateTime
MedicationDispense _whenHandedOver Extensions for whenHandedOver Element
MedicationDispense destination Identification of the facility/location where the medication was shipped to, as part of the dispense event. Reference
MedicationDispense receiver Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. Reference
MedicationDispense note Extra information about the dispense that could not be conveyed in the other attributes. Annotation
MedicationDispense dosageInstruction Indicates how the medication is to be used by the patient. Dosage
MedicationDispense substitution 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
MedicationDispense detectedIssue 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, duplicate therapy, dosage alert etc. Reference
MedicationDispense eventHistory A summary of the events of interest that have occurred, such as when the dispense was verified. Reference
MedicationDispense_Performer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationDispense_Performer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationDispense_Performer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationDispense_Performer function Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. CodeableConcept
MedicationDispense_Performer actor The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. Reference
MedicationDispense_Substitution id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationDispense_Substitution extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationDispense_Substitution modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationDispense_Substitution wasSubstituted True if the dispenser dispensed a different drug or product from what was prescribed. boolean
MedicationDispense_Substitution _wasSubstituted Extensions for wasSubstituted Element
MedicationDispense_Substitution type A code signifying whether a different drug was dispensed from what was prescribed. CodeableConcept
MedicationDispense_Substitution reason Indicates the reason for the substitution (or lack of substitution) from what was prescribed. CodeableConcept
MedicationDispense_Substitution responsibleParty The person or organization that has primary responsibility for the substitution. Reference
MedicationKnowledge resourceType This is a MedicationKnowledge resource MedicationKnowledge
MedicationKnowledge id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicationKnowledge meta 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. Meta
MedicationKnowledge implicitRules 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. uri
MedicationKnowledge _implicitRules Extensions for implicitRules Element
MedicationKnowledge language The base language in which the resource is written. code
MedicationKnowledge _language Extensions for language Element
MedicationKnowledge text 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. Narrative
MedicationKnowledge contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicationKnowledge extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge code 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. CodeableConcept
MedicationKnowledge status A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties. code
MedicationKnowledge _status Extensions for status Element
MedicationKnowledge manufacturer Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. Reference
MedicationKnowledge doseForm Describes the form of the item. Powder; tablets; capsule. CodeableConcept
MedicationKnowledge amount Specific amount of the drug in the packaged 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.). Quantity
MedicationKnowledge synonym Additional 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. string
MedicationKnowledge _synonym Extensions for synonym Element
MedicationKnowledge relatedMedicationKnowledge Associated or related knowledge about a medication. MedicationKnowledge_RelatedMedicationKnowledge
MedicationKnowledge associatedMedication 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). Reference
MedicationKnowledge productType Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.). CodeableConcept
MedicationKnowledge monograph Associated documentation about the medication. MedicationKnowledge_Monograph
MedicationKnowledge ingredient Identifies a particular constituent of interest in the product. MedicationKnowledge_Ingredient
MedicationKnowledge preparationInstruction The instructions for preparing the medication. markdown
MedicationKnowledge _preparationInstruction Extensions for preparationInstruction Element
MedicationKnowledge intendedRoute The intended or approved route of administration. CodeableConcept
MedicationKnowledge cost The price of the medication. MedicationKnowledge_Cost
MedicationKnowledge monitoringProgram The program under which the medication is reviewed. MedicationKnowledge_MonitoringProgram
MedicationKnowledge administrationGuidelines Guidelines for the administration of the medication. MedicationKnowledge_AdministrationGuidelines
MedicationKnowledge medicineClassification Categorization of the medication within a formulary or classification system. MedicationKnowledge_MedicineClassification
MedicationKnowledge packaging Information that only applies to packages (not products). MedicationKnowledge_Packaging
MedicationKnowledge drugCharacteristic Specifies descriptive properties of the medicine, such as color, shape, imprints, etc. MedicationKnowledge_DrugCharacteristic
MedicationKnowledge contraindication Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.). Reference
MedicationKnowledge regulatory Regulatory information about a medication. MedicationKnowledge_Regulatory
MedicationKnowledge kinetics The time course of drug absorption, distribution, metabolism and excretion of a medication from the body. MedicationKnowledge_Kinetics
MedicationKnowledge_AdministrationGuidelines id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_AdministrationGuidelines extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_AdministrationGuidelines modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_AdministrationGuidelines dosage Dosage for the medication for the specific guidelines. MedicationKnowledge_Dosage
MedicationKnowledge_AdministrationGuidelines indicationCodeableConcept Indication for use that apply to the specific administration guidelines. CodeableConcept
MedicationKnowledge_AdministrationGuidelines indicationReference Indication for use that apply to the specific administration guidelines. Reference
MedicationKnowledge_AdministrationGuidelines patientCharacteristics Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.). MedicationKnowledge_PatientCharacteristics
MedicationKnowledge_Cost id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Cost extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Cost modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Cost type The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost. CodeableConcept
MedicationKnowledge_Cost source The source or owner that assigns the price to the medication. string
MedicationKnowledge_Cost _source Extensions for source Element
MedicationKnowledge_Cost cost The price of the medication. Money
MedicationKnowledge_Dosage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Dosage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Dosage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Dosage type The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.). CodeableConcept
MedicationKnowledge_Dosage dosage Dosage for the medication for the specific guidelines. Dosage
MedicationKnowledge_DrugCharacteristic id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_DrugCharacteristic extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_DrugCharacteristic modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_DrugCharacteristic type A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint). CodeableConcept
MedicationKnowledge_DrugCharacteristic valueCodeableConcept Description of the characteristic. CodeableConcept
MedicationKnowledge_DrugCharacteristic valueString Description of the characteristic. notDefined
MedicationKnowledge_DrugCharacteristic _valueString Extensions for valueString Element
MedicationKnowledge_DrugCharacteristic valueQuantity Description of the characteristic. Quantity
MedicationKnowledge_DrugCharacteristic valueBase64Binary Description of the characteristic. notDefined
MedicationKnowledge_DrugCharacteristic _valueBase64Binary Extensions for valueBase64Binary Element
MedicationKnowledge_Ingredient id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Ingredient extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Ingredient modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Ingredient itemCodeableConcept The actual ingredient - either a substance (simple ingredient) or another medication. CodeableConcept
MedicationKnowledge_Ingredient itemReference The actual ingredient - either a substance (simple ingredient) or another medication. Reference
MedicationKnowledge_Ingredient isActive Indication of whether this ingredient affects the therapeutic action of the drug. boolean
MedicationKnowledge_Ingredient _isActive Extensions for isActive Element
MedicationKnowledge_Ingredient strength 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. Ratio
MedicationKnowledge_Kinetics id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Kinetics extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Kinetics modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Kinetics areaUnderCurve The drug concentration measured at certain discrete points in time. Quantity
MedicationKnowledge_Kinetics lethalDose50 The median lethal dose of a drug. Quantity
MedicationKnowledge_Kinetics halfLifePeriod The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half. Duration
MedicationKnowledge_MaxDispense id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_MaxDispense extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_MaxDispense modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_MaxDispense quantity The maximum number of units of the medication that can be dispensed. Quantity
MedicationKnowledge_MaxDispense period The period that applies to the maximum number of units. Duration
MedicationKnowledge_MedicineClassification id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_MedicineClassification extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_MedicineClassification modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_MedicineClassification type The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification). CodeableConcept
MedicationKnowledge_MedicineClassification classification Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.). CodeableConcept
MedicationKnowledge_MonitoringProgram id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_MonitoringProgram extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_MonitoringProgram modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_MonitoringProgram type Type of program under which the medication is monitored. CodeableConcept
MedicationKnowledge_MonitoringProgram name Name of the reviewing program. string
MedicationKnowledge_MonitoringProgram _name Extensions for name Element
MedicationKnowledge_Monograph id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Monograph extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Monograph modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Monograph type The category of documentation about the medication. (e.g. professional monograph, patient education monograph). CodeableConcept
MedicationKnowledge_Monograph source Associated documentation about the medication. Reference
MedicationKnowledge_Packaging id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Packaging extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Packaging modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Packaging type A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle). CodeableConcept
MedicationKnowledge_Packaging quantity The number of product units the package would contain if fully loaded. Quantity
MedicationKnowledge_PatientCharacteristics id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_PatientCharacteristics extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_PatientCharacteristics modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_PatientCharacteristics characteristicCodeableConcept Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender). CodeableConcept
MedicationKnowledge_PatientCharacteristics characteristicQuantity Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender). Quantity
MedicationKnowledge_PatientCharacteristics value The specific characteristic (e.g. height, weight, gender, etc.). string
MedicationKnowledge_PatientCharacteristics _value Extensions for value Element
MedicationKnowledge_Regulatory id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Regulatory extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Regulatory modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Regulatory regulatoryAuthority The authority that is specifying the regulations. Reference
MedicationKnowledge_Regulatory substitution Specifies if changes are allowed when dispensing a medication from a regulatory perspective. MedicationKnowledge_Substitution
MedicationKnowledge_Regulatory schedule Specifies the schedule of a medication in jurisdiction. MedicationKnowledge_Schedule
MedicationKnowledge_Regulatory maxDispense The maximum number of units of the medication that can be dispensed in a period. MedicationKnowledge_MaxDispense
MedicationKnowledge_RelatedMedicationKnowledge id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_RelatedMedicationKnowledge extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_RelatedMedicationKnowledge modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_RelatedMedicationKnowledge type The category of the associated medication knowledge reference. CodeableConcept
MedicationKnowledge_RelatedMedicationKnowledge reference Associated documentation about the associated medication knowledge. Reference
MedicationKnowledge_Schedule id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Schedule extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Schedule modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Schedule schedule Specifies the specific drug schedule. CodeableConcept
MedicationKnowledge_Substitution id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationKnowledge_Substitution extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationKnowledge_Substitution modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationKnowledge_Substitution type Specifies the type of substitution allowed. CodeableConcept
MedicationKnowledge_Substitution allowed Specifies if regulation allows for changes in the medication when dispensing. boolean
MedicationKnowledge_Substitution _allowed Extensions for allowed Element
MedicationRequest resourceType This is a MedicationRequest resource MedicationRequest
MedicationRequest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicationRequest meta 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. Meta
MedicationRequest implicitRules 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. uri
MedicationRequest _implicitRules Extensions for implicitRules Element
MedicationRequest language The base language in which the resource is written. code
MedicationRequest _language Extensions for language Element
MedicationRequest text 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. Narrative
MedicationRequest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicationRequest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationRequest identifier 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. Identifier
MedicationRequest status A code specifying the current state of the order. Generally, this will be active or completed state. code
MedicationRequest _status Extensions for status Element
MedicationRequest statusReason Captures the reason for the current state of the MedicationRequest. CodeableConcept
MedicationRequest intent Whether the request is a proposal, plan, or an original order. code
MedicationRequest _intent Extensions for intent Element
MedicationRequest category Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). CodeableConcept
MedicationRequest priority Indicates how quickly the Medication Request should be addressed with respect to other requests. code
MedicationRequest _priority Extensions for priority Element
MedicationRequest doNotPerform If true indicates that the provider is asking for the medication request not to occur. boolean
MedicationRequest _doNotPerform Extensions for doNotPerform Element
MedicationRequest reportedBoolean 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. notDefined
MedicationRequest _reportedBoolean Extensions for reportedBoolean Element
MedicationRequest reportedReference 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. Reference
MedicationRequest medicationCodeableConcept 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. CodeableConcept
MedicationRequest medicationReference 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. Reference
MedicationRequest subject A link to a resource representing the person or set of individuals to whom the medication will be given. Reference
MedicationRequest encounter The Encounter during which this [x] was created or to which the creation of this record is tightly associated. Reference
MedicationRequest supportingInformation Include additional information (for example, patient height and weight) that supports the ordering of the medication. Reference
MedicationRequest authoredOn The date (and perhaps time) when the prescription was initially written or authored on. dateTime
MedicationRequest _authoredOn Extensions for authoredOn Element
MedicationRequest requester The individual, organization, or device that initiated the request and has responsibility for its activation. Reference
MedicationRequest performer The specified desired performer of the medication treatment (e.g. the performer of the medication administration). Reference
MedicationRequest performerType Indicates the type of performer of the administration of the medication. CodeableConcept
MedicationRequest recorder The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. Reference
MedicationRequest reasonCode The reason or the indication for ordering or not ordering the medication. CodeableConcept
MedicationRequest reasonReference Condition or observation that supports why the medication was ordered. Reference
MedicationRequest instantiatesCanonical The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest. canonical
MedicationRequest _instantiatesCanonical Extensions for instantiatesCanonical Element
MedicationRequest instantiatesUri The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest. uri
MedicationRequest _instantiatesUri Extensions for instantiatesUri Element
MedicationRequest basedOn A plan or request that is fulfilled in whole or in part by this medication request. Reference
MedicationRequest groupIdentifier A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. Identifier
MedicationRequest courseOfTherapyType The description of the overall patte3rn of the administration of the medication to the patient. CodeableConcept
MedicationRequest insurance Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. Reference
MedicationRequest note Extra information about the prescription that could not be conveyed by the other attributes. Annotation
MedicationRequest dosageInstruction Indicates how the medication is to be used by the patient. Dosage
MedicationRequest dispenseRequest 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
MedicationRequest substitution 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
MedicationRequest priorPrescription A link to a resource representing an earlier order related order or prescription. Reference
MedicationRequest detectedIssue 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, duplicate therapy, dosage alert etc. Reference
MedicationRequest eventHistory 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. Reference
MedicationRequest_DispenseRequest id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationRequest_DispenseRequest extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationRequest_DispenseRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationRequest_DispenseRequest initialFill Indicates the quantity or duration for the first dispense of the medication. MedicationRequest_InitialFill
MedicationRequest_DispenseRequest dispenseInterval The minimum period of time that must occur between dispenses of the medication. Duration
MedicationRequest_DispenseRequest validityPeriod This indicates the validity period of a prescription (stale dating the Prescription). Period
MedicationRequest_DispenseRequest numberOfRepeatsAllowed 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. unsignedInt
MedicationRequest_DispenseRequest _numberOfRepeatsAllowed Extensions for numberOfRepeatsAllowed Element
MedicationRequest_DispenseRequest quantity The amount that is to be dispensed for one fill. Quantity
MedicationRequest_DispenseRequest expectedSupplyDuration 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. Duration
MedicationRequest_DispenseRequest performer Indicates the intended dispensing Organization specified by the prescriber. Reference
MedicationRequest_InitialFill id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationRequest_InitialFill extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationRequest_InitialFill modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationRequest_InitialFill quantity The amount or quantity to provide as part of the first dispense. Quantity
MedicationRequest_InitialFill duration The length of time that the first dispense is expected to last. Duration
MedicationRequest_Substitution id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicationRequest_Substitution extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationRequest_Substitution modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationRequest_Substitution allowedBoolean True if the prescriber allows a different drug to be dispensed from what was prescribed. notDefined
MedicationRequest_Substitution _allowedBoolean Extensions for allowedBoolean Element
MedicationRequest_Substitution allowedCodeableConcept True if the prescriber allows a different drug to be dispensed from what was prescribed. CodeableConcept
MedicationRequest_Substitution reason Indicates the reason for the substitution, or why substitution must or must not be performed. CodeableConcept
MedicationStatement resourceType This is a MedicationStatement resource MedicationStatement
MedicationStatement id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicationStatement meta 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. Meta
MedicationStatement implicitRules 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. uri
MedicationStatement _implicitRules Extensions for implicitRules Element
MedicationStatement language The base language in which the resource is written. code
MedicationStatement _language Extensions for language Element
MedicationStatement text 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. Narrative
MedicationStatement contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicationStatement extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicationStatement modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicationStatement identifier 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. Identifier
MedicationStatement basedOn A plan, proposal or order that is fulfilled in whole or in part by this event. Reference
MedicationStatement partOf A larger event of which this particular event is a component or step. Reference
MedicationStatement status A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed. code
MedicationStatement _status Extensions for status Element
MedicationStatement statusReason Captures the reason for the current state of the MedicationStatement. CodeableConcept
MedicationStatement category Indicates where the medication is expected to be consumed or administered. CodeableConcept
MedicationStatement medicationCodeableConcept 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. CodeableConcept
MedicationStatement medicationReference 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. Reference
MedicationStatement subject The person, animal or group who is/was taking the medication. Reference
MedicationStatement context The encounter or episode of care that establishes the context for this MedicationStatement. Reference
MedicationStatement effectiveDateTime 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.taken element is No). notDefined
MedicationStatement _effectiveDateTime Extensions for effectiveDateTime Element
MedicationStatement effectivePeriod 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.taken element is No). Period
MedicationStatement dateAsserted The date when the medication statement was asserted by the information source. dateTime
MedicationStatement _dateAsserted Extensions for dateAsserted Element
MedicationStatement informationSource 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. Reference
MedicationStatement derivedFrom Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. Reference
MedicationStatement reasonCode A reason for why the medication is being/was taken. CodeableConcept
MedicationStatement reasonReference Condition or observation that supports why the medication is being/was taken. Reference
MedicationStatement note Provides extra information about the medication statement that is not conveyed by the other attributes. Annotation
MedicationStatement dosage Indicates how the medication is/was or should be taken by the patient. Dosage
Medication_Batch id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Medication_Batch extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Medication_Batch modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Medication_Batch lotNumber The assigned lot number of a batch of the specified product. string
Medication_Batch _lotNumber Extensions for lotNumber Element
Medication_Batch expirationDate When this specific batch of product will expire. dateTime
Medication_Batch _expirationDate Extensions for expirationDate Element
Medication_Ingredient id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Medication_Ingredient extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Medication_Ingredient modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Medication_Ingredient itemCodeableConcept The actual ingredient - either a substance (simple ingredient) or another medication of a medication. CodeableConcept
Medication_Ingredient itemReference The actual ingredient - either a substance (simple ingredient) or another medication of a medication. Reference
Medication_Ingredient isActive Indication of whether this ingredient affects the therapeutic action of the drug. boolean
Medication_Ingredient _isActive Extensions for isActive Element
Medication_Ingredient strength 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. Ratio
MedicinalProduct resourceType This is a MedicinalProduct resource MedicinalProduct
MedicinalProduct id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProduct meta 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. Meta
MedicinalProduct implicitRules 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. uri
MedicinalProduct _implicitRules Extensions for implicitRules Element
MedicinalProduct language The base language in which the resource is written. code
MedicinalProduct _language Extensions for language Element
MedicinalProduct text 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. Narrative
MedicinalProduct contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProduct extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProduct modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProduct identifier Business identifier for this product. Could be an MPID. Identifier
MedicinalProduct type Regulatory type, e.g. Investigational or Authorized. CodeableConcept
MedicinalProduct domain If this medicine applies to human or veterinary uses. Coding
MedicinalProduct combinedPharmaceuticalDoseForm The dose form for a single part product, or combined form of a multiple part product. CodeableConcept
MedicinalProduct legalStatusOfSupply The legal status of supply of the medicinal product as classified by the regulator. CodeableConcept
MedicinalProduct additionalMonitoringIndicator Whether the Medicinal Product is subject to additional monitoring for regulatory reasons. CodeableConcept
MedicinalProduct specialMeasures Whether the Medicinal Product is subject to special measures for regulatory reasons. string
MedicinalProduct _specialMeasures Extensions for specialMeasures Element
MedicinalProduct paediatricUseIndicator If authorised for use in children. CodeableConcept
MedicinalProduct productClassification Allows the product to be classified by various systems. CodeableConcept
MedicinalProduct marketingStatus Marketing status of the medicinal product, in contrast to marketing authorizaton. MarketingStatus
MedicinalProduct pharmaceuticalProduct Pharmaceutical aspects of product. Reference
MedicinalProduct packagedMedicinalProduct Package representation for the product. Reference
MedicinalProduct attachedDocument Supporting documentation, typically for regulatory submission. Reference
MedicinalProduct masterFile A master file for to the medicinal product (e.g. Pharmacovigilance System Master File). Reference
MedicinalProduct contact A product specific contact, person (in a role), or an organization. Reference
MedicinalProduct clinicalTrial Clinical trials or studies that this product is involved in. Reference
MedicinalProduct name The product's name, including full name and possibly coded parts. MedicinalProduct_Name
MedicinalProduct crossReference Reference to another product, e.g. for linking authorised to investigational product. Identifier
MedicinalProduct manufacturingBusinessOperation An operation applied to the product, for manufacturing or adminsitrative purpose. MedicinalProduct_ManufacturingBusinessOperation
MedicinalProduct specialDesignation Indicates if the medicinal product has an orphan designation for the treatment of a rare disease. MedicinalProduct_SpecialDesignation
MedicinalProductAuthorization resourceType This is a MedicinalProductAuthorization resource MedicinalProductAuthorization
MedicinalProductAuthorization id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductAuthorization meta 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. Meta
MedicinalProductAuthorization implicitRules 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. uri
MedicinalProductAuthorization _implicitRules Extensions for implicitRules Element
MedicinalProductAuthorization language The base language in which the resource is written. code
MedicinalProductAuthorization _language Extensions for language Element
MedicinalProductAuthorization text 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. Narrative
MedicinalProductAuthorization contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductAuthorization extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductAuthorization modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductAuthorization identifier Business identifier for the marketing authorization, as assigned by a regulator. Identifier
MedicinalProductAuthorization subject The medicinal product that is being authorized. Reference
MedicinalProductAuthorization country The country in which the marketing authorization has been granted. CodeableConcept
MedicinalProductAuthorization jurisdiction Jurisdiction within a country. CodeableConcept
MedicinalProductAuthorization status The status of the marketing authorization. CodeableConcept
MedicinalProductAuthorization statusDate The date at which the given status has become applicable. dateTime
MedicinalProductAuthorization _statusDate Extensions for statusDate Element
MedicinalProductAuthorization restoreDate The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored. dateTime
MedicinalProductAuthorization _restoreDate Extensions for restoreDate Element
MedicinalProductAuthorization validityPeriod The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format. Period
MedicinalProductAuthorization dataExclusivityPeriod A period of time after authorization before generic product applicatiosn can be submitted. Period
MedicinalProductAuthorization dateOfFirstAuthorization The date when the first authorization was granted by a Medicines Regulatory Agency. dateTime
MedicinalProductAuthorization _dateOfFirstAuthorization Extensions for dateOfFirstAuthorization Element
MedicinalProductAuthorization internationalBirthDate Date of first marketing authorization for a company's new medicinal product in any country in the World. dateTime
MedicinalProductAuthorization _internationalBirthDate Extensions for internationalBirthDate Element
MedicinalProductAuthorization legalBasis The legal framework against which this authorization is granted. CodeableConcept
MedicinalProductAuthorization jurisdictionalAuthorization Authorization in areas within a country. MedicinalProductAuthorization_JurisdictionalAuthorization
MedicinalProductAuthorization holder Marketing Authorization Holder. Reference
MedicinalProductAuthorization regulator Medicines Regulatory Agency. Reference
MedicinalProductAuthorization procedure The regulatory procedure for granting or amending a marketing authorization. MedicinalProductAuthorization_Procedure
MedicinalProductAuthorization_JurisdictionalAuthorization id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductAuthorization_JurisdictionalAuthorization extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductAuthorization_JurisdictionalAuthorization modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductAuthorization_JurisdictionalAuthorization identifier The assigned number for the marketing authorization. Identifier
MedicinalProductAuthorization_JurisdictionalAuthorization country Country of authorization. CodeableConcept
MedicinalProductAuthorization_JurisdictionalAuthorization jurisdiction Jurisdiction within a country. CodeableConcept
MedicinalProductAuthorization_JurisdictionalAuthorization legalStatusOfSupply The legal status of supply in a jurisdiction or region. CodeableConcept
MedicinalProductAuthorization_JurisdictionalAuthorization validityPeriod The start and expected end date of the authorization. Period
MedicinalProductAuthorization_Procedure id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductAuthorization_Procedure extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductAuthorization_Procedure modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductAuthorization_Procedure identifier Identifier for this procedure. Identifier
MedicinalProductAuthorization_Procedure type Type of procedure. CodeableConcept
MedicinalProductAuthorization_Procedure datePeriod Date of procedure. Period
MedicinalProductAuthorization_Procedure dateDateTime Date of procedure. notDefined
MedicinalProductAuthorization_Procedure _dateDateTime Extensions for dateDateTime Element
MedicinalProductAuthorization_Procedure application Applcations submitted to obtain a marketing authorization. MedicinalProductAuthorization_Procedure
MedicinalProductContraindication resourceType This is a MedicinalProductContraindication resource MedicinalProductContraindication
MedicinalProductContraindication id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductContraindication meta 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. Meta
MedicinalProductContraindication implicitRules 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. uri
MedicinalProductContraindication _implicitRules Extensions for implicitRules Element
MedicinalProductContraindication language The base language in which the resource is written. code
MedicinalProductContraindication _language Extensions for language Element
MedicinalProductContraindication text 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. Narrative
MedicinalProductContraindication contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductContraindication extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductContraindication modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductContraindication subject The medication for which this is an indication. Reference
MedicinalProductContraindication disease The disease, symptom or procedure for the contraindication. CodeableConcept
MedicinalProductContraindication diseaseStatus The status of the disease or symptom for the contraindication. CodeableConcept
MedicinalProductContraindication comorbidity A comorbidity (concurrent condition) or coinfection. CodeableConcept
MedicinalProductContraindication therapeuticIndication Information about the use of the medicinal product in relation to other therapies as part of the indication. Reference
MedicinalProductContraindication otherTherapy Information about the use of the medicinal product in relation to other therapies described as part of the indication. MedicinalProductContraindication_OtherTherapy
MedicinalProductContraindication population The population group to which this applies. Population
MedicinalProductContraindication_OtherTherapy id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductContraindication_OtherTherapy extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductContraindication_OtherTherapy modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductContraindication_OtherTherapy therapyRelationshipType The type of relationship between the medicinal product indication or contraindication and another therapy. CodeableConcept
MedicinalProductContraindication_OtherTherapy medicationCodeableConcept Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. CodeableConcept
MedicinalProductContraindication_OtherTherapy medicationReference Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. Reference
MedicinalProductIndication resourceType This is a MedicinalProductIndication resource MedicinalProductIndication
MedicinalProductIndication id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductIndication meta 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. Meta
MedicinalProductIndication implicitRules 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. uri
MedicinalProductIndication _implicitRules Extensions for implicitRules Element
MedicinalProductIndication language The base language in which the resource is written. code
MedicinalProductIndication _language Extensions for language Element
MedicinalProductIndication text 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. Narrative
MedicinalProductIndication contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductIndication extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductIndication modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductIndication subject The medication for which this is an indication. Reference
MedicinalProductIndication diseaseSymptomProcedure The disease, symptom or procedure that is the indication for treatment. CodeableConcept
MedicinalProductIndication diseaseStatus The status of the disease or symptom for which the indication applies. CodeableConcept
MedicinalProductIndication comorbidity Comorbidity (concurrent condition) or co-infection as part of the indication. CodeableConcept
MedicinalProductIndication intendedEffect The intended effect, aim or strategy to be achieved by the indication. CodeableConcept
MedicinalProductIndication duration Timing or duration information as part of the indication. Quantity
MedicinalProductIndication otherTherapy Information about the use of the medicinal product in relation to other therapies described as part of the indication. MedicinalProductIndication_OtherTherapy
MedicinalProductIndication undesirableEffect Describe the undesirable effects of the medicinal product. Reference
MedicinalProductIndication population The population group to which this applies. Population
MedicinalProductIndication_OtherTherapy id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductIndication_OtherTherapy extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductIndication_OtherTherapy modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductIndication_OtherTherapy therapyRelationshipType The type of relationship between the medicinal product indication or contraindication and another therapy. CodeableConcept
MedicinalProductIndication_OtherTherapy medicationCodeableConcept Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. CodeableConcept
MedicinalProductIndication_OtherTherapy medicationReference Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication. Reference
MedicinalProductIngredient resourceType This is a MedicinalProductIngredient resource MedicinalProductIngredient
MedicinalProductIngredient id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductIngredient meta 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. Meta
MedicinalProductIngredient implicitRules 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. uri
MedicinalProductIngredient _implicitRules Extensions for implicitRules Element
MedicinalProductIngredient language The base language in which the resource is written. code
MedicinalProductIngredient _language Extensions for language Element
MedicinalProductIngredient text 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. Narrative
MedicinalProductIngredient contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductIngredient extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductIngredient modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductIngredient identifier 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. Identifier
MedicinalProductIngredient role Ingredient role e.g. Active ingredient, excipient. CodeableConcept
MedicinalProductIngredient allergenicIndicator If the ingredient is a known or suspected allergen. boolean
MedicinalProductIngredient _allergenicIndicator Extensions for allergenicIndicator Element
MedicinalProductIngredient manufacturer Manufacturer of this Ingredient. Reference
MedicinalProductIngredient specifiedSubstance A specified substance that comprises this ingredient. MedicinalProductIngredient_SpecifiedSubstance
MedicinalProductIngredient substance The ingredient substance. MedicinalProductIngredient_Substance
MedicinalProductIngredient_ReferenceStrength id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductIngredient_ReferenceStrength extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductIngredient_ReferenceStrength modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductIngredient_ReferenceStrength substance Relevant reference substance. CodeableConcept
MedicinalProductIngredient_ReferenceStrength strength Strength expressed in terms of a reference substance. Ratio
MedicinalProductIngredient_ReferenceStrength strengthLowLimit Strength expressed in terms of a reference substance. Ratio
MedicinalProductIngredient_ReferenceStrength measurementPoint For when strength is measured at a particular point or distance. string
MedicinalProductIngredient_ReferenceStrength _measurementPoint Extensions for measurementPoint Element
MedicinalProductIngredient_ReferenceStrength country The country or countries for which the strength range applies. CodeableConcept
MedicinalProductIngredient_SpecifiedSubstance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductIngredient_SpecifiedSubstance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductIngredient_SpecifiedSubstance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductIngredient_SpecifiedSubstance code The specified substance. CodeableConcept
MedicinalProductIngredient_SpecifiedSubstance group The group of specified substance, e.g. group 1 to 4. CodeableConcept
MedicinalProductIngredient_SpecifiedSubstance confidentiality Confidentiality level of the specified substance as the ingredient. CodeableConcept
MedicinalProductIngredient_SpecifiedSubstance strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product. MedicinalProductIngredient_Strength
MedicinalProductIngredient_Strength id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductIngredient_Strength extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductIngredient_Strength modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductIngredient_Strength presentation The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Ratio
MedicinalProductIngredient_Strength presentationLowLimit A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit. Ratio
MedicinalProductIngredient_Strength concentration The strength per unitary volume (or mass). Ratio
MedicinalProductIngredient_Strength concentrationLowLimit A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit. Ratio
MedicinalProductIngredient_Strength measurementPoint For when strength is measured at a particular point or distance. string
MedicinalProductIngredient_Strength _measurementPoint Extensions for measurementPoint Element
MedicinalProductIngredient_Strength country The country or countries for which the strength range applies. CodeableConcept
MedicinalProductIngredient_Strength referenceStrength Strength expressed in terms of a reference substance. MedicinalProductIngredient_ReferenceStrength
MedicinalProductIngredient_Substance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductIngredient_Substance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductIngredient_Substance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductIngredient_Substance code The ingredient substance. CodeableConcept
MedicinalProductIngredient_Substance strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product. MedicinalProductIngredient_Strength
MedicinalProductInteraction resourceType This is a MedicinalProductInteraction resource MedicinalProductInteraction
MedicinalProductInteraction id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductInteraction meta 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. Meta
MedicinalProductInteraction implicitRules 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. uri
MedicinalProductInteraction _implicitRules Extensions for implicitRules Element
MedicinalProductInteraction language The base language in which the resource is written. code
MedicinalProductInteraction _language Extensions for language Element
MedicinalProductInteraction text 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. Narrative
MedicinalProductInteraction contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductInteraction extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductInteraction modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductInteraction subject The medication for which this is a described interaction. Reference
MedicinalProductInteraction description The interaction described. string
MedicinalProductInteraction _description Extensions for description Element
MedicinalProductInteraction interactant The specific medication, food or laboratory test that interacts. MedicinalProductInteraction_Interactant
MedicinalProductInteraction type The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction. CodeableConcept
MedicinalProductInteraction effect The effect of the interaction, for example "reduced gastric absorption of primary medication". CodeableConcept
MedicinalProductInteraction incidence The incidence of the interaction, e.g. theoretical, observed. CodeableConcept
MedicinalProductInteraction management Actions for managing the interaction. CodeableConcept
MedicinalProductInteraction_Interactant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductInteraction_Interactant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductInteraction_Interactant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductInteraction_Interactant itemReference The specific medication, food or laboratory test that interacts. Reference
MedicinalProductInteraction_Interactant itemCodeableConcept The specific medication, food or laboratory test that interacts. CodeableConcept
MedicinalProductManufactured resourceType This is a MedicinalProductManufactured resource MedicinalProductManufactured
MedicinalProductManufactured id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductManufactured meta 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. Meta
MedicinalProductManufactured implicitRules 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. uri
MedicinalProductManufactured _implicitRules Extensions for implicitRules Element
MedicinalProductManufactured language The base language in which the resource is written. code
MedicinalProductManufactured _language Extensions for language Element
MedicinalProductManufactured text 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. Narrative
MedicinalProductManufactured contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductManufactured extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductManufactured modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductManufactured manufacturedDoseForm Dose form as manufactured and before any transformation into the pharmaceutical product. CodeableConcept
MedicinalProductManufactured unitOfPresentation The “real world” units in which the quantity of the manufactured item is described. CodeableConcept
MedicinalProductManufactured quantity The quantity or "count number" of the manufactured item. Quantity
MedicinalProductManufactured manufacturer Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues). Reference
MedicinalProductManufactured ingredient Ingredient. Reference
MedicinalProductManufactured physicalCharacteristics Dimensions, color etc. ProdCharacteristic
MedicinalProductManufactured otherCharacteristics Other codeable characteristics. CodeableConcept
MedicinalProductPackaged resourceType This is a MedicinalProductPackaged resource MedicinalProductPackaged
MedicinalProductPackaged id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductPackaged meta 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. Meta
MedicinalProductPackaged implicitRules 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. uri
MedicinalProductPackaged _implicitRules Extensions for implicitRules Element
MedicinalProductPackaged language The base language in which the resource is written. code
MedicinalProductPackaged _language Extensions for language Element
MedicinalProductPackaged text 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. Narrative
MedicinalProductPackaged contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductPackaged extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPackaged modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPackaged identifier Unique identifier. Identifier
MedicinalProductPackaged subject The product with this is a pack for. Reference
MedicinalProductPackaged description Textual description. string
MedicinalProductPackaged _description Extensions for description Element
MedicinalProductPackaged legalStatusOfSupply The legal status of supply of the medicinal product as classified by the regulator. CodeableConcept
MedicinalProductPackaged marketingStatus Marketing information. MarketingStatus
MedicinalProductPackaged marketingAuthorization Manufacturer of this Package Item. Reference
MedicinalProductPackaged manufacturer Manufacturer of this Package Item. Reference
MedicinalProductPackaged batchIdentifier Batch numbering. MedicinalProductPackaged_BatchIdentifier
MedicinalProductPackaged packageItem A packaging item, as a contained for medicine, possibly with other packaging items within. MedicinalProductPackaged_PackageItem
MedicinalProductPackaged_BatchIdentifier id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductPackaged_BatchIdentifier extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPackaged_BatchIdentifier modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPackaged_BatchIdentifier outerPackaging A number appearing on the outer packaging of a specific batch. Identifier
MedicinalProductPackaged_BatchIdentifier immediatePackaging A number appearing on the immediate packaging (and not the outer packaging). Identifier
MedicinalProductPackaged_PackageItem id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductPackaged_PackageItem extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPackaged_PackageItem modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPackaged_PackageItem identifier Including possibly Data Carrier Identifier. Identifier
MedicinalProductPackaged_PackageItem type The physical type of the container of the medicine. CodeableConcept
MedicinalProductPackaged_PackageItem quantity The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1. Quantity
MedicinalProductPackaged_PackageItem material Material type of the package item. CodeableConcept
MedicinalProductPackaged_PackageItem alternateMaterial A possible alternate material for the packaging. CodeableConcept
MedicinalProductPackaged_PackageItem device A device accompanying a medicinal product. Reference
MedicinalProductPackaged_PackageItem manufacturedItem The manufactured item as contained in the packaged medicinal product. Reference
MedicinalProductPackaged_PackageItem packageItem Allows containers within containers. MedicinalProductPackaged_PackageItem
MedicinalProductPackaged_PackageItem physicalCharacteristics Dimensions, color etc. ProdCharacteristic
MedicinalProductPackaged_PackageItem otherCharacteristics Other codeable characteristics. CodeableConcept
MedicinalProductPackaged_PackageItem shelfLifeStorage Shelf Life and storage information. ProductShelfLife
MedicinalProductPackaged_PackageItem manufacturer Manufacturer of this Package Item. Reference
MedicinalProductPharmaceutical resourceType This is a MedicinalProductPharmaceutical resource MedicinalProductPharmaceutical
MedicinalProductPharmaceutical id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductPharmaceutical meta 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. Meta
MedicinalProductPharmaceutical implicitRules 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. uri
MedicinalProductPharmaceutical _implicitRules Extensions for implicitRules Element
MedicinalProductPharmaceutical language The base language in which the resource is written. code
MedicinalProductPharmaceutical _language Extensions for language Element
MedicinalProductPharmaceutical text 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. Narrative
MedicinalProductPharmaceutical contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductPharmaceutical extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPharmaceutical modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPharmaceutical identifier An identifier for the pharmaceutical medicinal product. Identifier
MedicinalProductPharmaceutical administrableDoseForm The administrable dose form, after necessary reconstitution. CodeableConcept
MedicinalProductPharmaceutical unitOfPresentation Todo. CodeableConcept
MedicinalProductPharmaceutical ingredient Ingredient. Reference
MedicinalProductPharmaceutical device Accompanying device. Reference
MedicinalProductPharmaceutical characteristics Characteristics e.g. a products onset of action. MedicinalProductPharmaceutical_Characteristics
MedicinalProductPharmaceutical routeOfAdministration The path by which the pharmaceutical product is taken into or makes contact with the body. MedicinalProductPharmaceutical_RouteOfAdministration
MedicinalProductPharmaceutical_Characteristics id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductPharmaceutical_Characteristics extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPharmaceutical_Characteristics modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPharmaceutical_Characteristics code A coded characteristic. CodeableConcept
MedicinalProductPharmaceutical_Characteristics status The status of characteristic e.g. assigned or pending. CodeableConcept
MedicinalProductPharmaceutical_RouteOfAdministration id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductPharmaceutical_RouteOfAdministration extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPharmaceutical_RouteOfAdministration modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPharmaceutical_RouteOfAdministration code Coded expression for the route. CodeableConcept
MedicinalProductPharmaceutical_RouteOfAdministration firstDose The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement. Quantity
MedicinalProductPharmaceutical_RouteOfAdministration maxSingleDose The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement. Quantity
MedicinalProductPharmaceutical_RouteOfAdministration maxDosePerDay The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation. Quantity
MedicinalProductPharmaceutical_RouteOfAdministration maxDosePerTreatmentPeriod The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation. Ratio
MedicinalProductPharmaceutical_RouteOfAdministration maxTreatmentPeriod The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation. Duration
MedicinalProductPharmaceutical_RouteOfAdministration targetSpecies A species for which this route applies. MedicinalProductPharmaceutical_TargetSpecies
MedicinalProductPharmaceutical_TargetSpecies id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductPharmaceutical_TargetSpecies extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPharmaceutical_TargetSpecies modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPharmaceutical_TargetSpecies code Coded expression for the species. CodeableConcept
MedicinalProductPharmaceutical_TargetSpecies withdrawalPeriod A species specific time during which consumption of animal product is not appropriate. MedicinalProductPharmaceutical_WithdrawalPeriod
MedicinalProductPharmaceutical_WithdrawalPeriod id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProductPharmaceutical_WithdrawalPeriod extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductPharmaceutical_WithdrawalPeriod modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductPharmaceutical_WithdrawalPeriod tissue Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk. CodeableConcept
MedicinalProductPharmaceutical_WithdrawalPeriod value A value for the time. Quantity
MedicinalProductPharmaceutical_WithdrawalPeriod supportingInformation Extra information about the withdrawal period. string
MedicinalProductPharmaceutical_WithdrawalPeriod _supportingInformation Extensions for supportingInformation Element
MedicinalProductUndesirableEffect resourceType This is a MedicinalProductUndesirableEffect resource MedicinalProductUndesirableEffect
MedicinalProductUndesirableEffect id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MedicinalProductUndesirableEffect meta 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. Meta
MedicinalProductUndesirableEffect implicitRules 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. uri
MedicinalProductUndesirableEffect _implicitRules Extensions for implicitRules Element
MedicinalProductUndesirableEffect language The base language in which the resource is written. code
MedicinalProductUndesirableEffect _language Extensions for language Element
MedicinalProductUndesirableEffect text 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. Narrative
MedicinalProductUndesirableEffect contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MedicinalProductUndesirableEffect extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProductUndesirableEffect modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProductUndesirableEffect subject The medication for which this is an indication. Reference
MedicinalProductUndesirableEffect symptomConditionEffect The symptom, condition or undesirable effect. CodeableConcept
MedicinalProductUndesirableEffect classification Classification of the effect. CodeableConcept
MedicinalProductUndesirableEffect frequencyOfOccurrence The frequency of occurrence of the effect. CodeableConcept
MedicinalProductUndesirableEffect population The population group to which this applies. Population
MedicinalProduct_CountryLanguage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProduct_CountryLanguage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProduct_CountryLanguage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProduct_CountryLanguage country Country code for where this name applies. CodeableConcept
MedicinalProduct_CountryLanguage jurisdiction Jurisdiction code for where this name applies. CodeableConcept
MedicinalProduct_CountryLanguage language Language code for this name. CodeableConcept
MedicinalProduct_ManufacturingBusinessOperation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProduct_ManufacturingBusinessOperation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProduct_ManufacturingBusinessOperation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProduct_ManufacturingBusinessOperation operationType The type of manufacturing operation. CodeableConcept
MedicinalProduct_ManufacturingBusinessOperation authorisationReferenceNumber Regulatory authorization reference number. Identifier
MedicinalProduct_ManufacturingBusinessOperation effectiveDate Regulatory authorization date. dateTime
MedicinalProduct_ManufacturingBusinessOperation _effectiveDate Extensions for effectiveDate Element
MedicinalProduct_ManufacturingBusinessOperation confidentialityIndicator To indicate if this proces is commercially confidential. CodeableConcept
MedicinalProduct_ManufacturingBusinessOperation manufacturer The manufacturer or establishment associated with the process. Reference
MedicinalProduct_ManufacturingBusinessOperation regulator A regulator which oversees the operation. Reference
MedicinalProduct_Name id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProduct_Name extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProduct_Name modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProduct_Name productName The full product name. string
MedicinalProduct_Name _productName Extensions for productName Element
MedicinalProduct_Name namePart Coding words or phrases of the name. MedicinalProduct_NamePart
MedicinalProduct_Name countryLanguage Country where the name applies. MedicinalProduct_CountryLanguage
MedicinalProduct_NamePart id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProduct_NamePart extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProduct_NamePart modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProduct_NamePart part A fragment of a product name. string
MedicinalProduct_NamePart _part Extensions for part Element
MedicinalProduct_NamePart type Idenifying type for this part of the name (e.g. strength part). Coding
MedicinalProduct_SpecialDesignation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MedicinalProduct_SpecialDesignation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MedicinalProduct_SpecialDesignation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MedicinalProduct_SpecialDesignation identifier Identifier for the designation, or procedure number. Identifier
MedicinalProduct_SpecialDesignation type The type of special designation, e.g. orphan drug, minor use. CodeableConcept
MedicinalProduct_SpecialDesignation intendedUse The intended use of the product, e.g. prevention, treatment. CodeableConcept
MedicinalProduct_SpecialDesignation indicationCodeableConcept Condition for which the medicinal use applies. CodeableConcept
MedicinalProduct_SpecialDesignation indicationReference Condition for which the medicinal use applies. Reference
MedicinalProduct_SpecialDesignation status For example granted, pending, expired or withdrawn. CodeableConcept
MedicinalProduct_SpecialDesignation date Date when the designation was granted. dateTime
MedicinalProduct_SpecialDesignation _date Extensions for date Element
MedicinalProduct_SpecialDesignation species Animal species for which this applies. CodeableConcept
MessageDefinition resourceType This is a MessageDefinition resource MessageDefinition
MessageDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MessageDefinition meta 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. Meta
MessageDefinition implicitRules 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. uri
MessageDefinition _implicitRules Extensions for implicitRules Element
MessageDefinition language The base language in which the resource is written. code
MessageDefinition _language Extensions for language Element
MessageDefinition text 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. Narrative
MessageDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MessageDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MessageDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MessageDefinition url The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server. uri
MessageDefinition _url Extensions for url Element
MessageDefinition identifier 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. Identifier
MessageDefinition version 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. string
MessageDefinition _version Extensions for version Element
MessageDefinition name 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. string
MessageDefinition _name Extensions for name Element
MessageDefinition title A short, descriptive, user-friendly title for the message definition. string
MessageDefinition _title Extensions for title Element
MessageDefinition replaces A MessageDefinition that is superseded by this definition. canonical
MessageDefinition status The status of this message definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
MessageDefinition _status Extensions for status Element
MessageDefinition experimental 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. boolean
MessageDefinition _experimental Extensions for experimental Element
MessageDefinition date The date (and optionally time) when the message definition 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 message definition changes. dateTime
MessageDefinition _date Extensions for date Element
MessageDefinition publisher The name of the organization or individual that published the message definition. string
MessageDefinition _publisher Extensions for publisher Element
MessageDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
MessageDefinition description A free text natural language description of the message definition from a consumer's perspective. markdown
MessageDefinition _description Extensions for description Element
MessageDefinition useContext 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. UsageContext
MessageDefinition jurisdiction A legal or geographic region in which the message definition is intended to be used. CodeableConcept
MessageDefinition purpose Explanation of why this message definition is needed and why it has been designed as it has. markdown
MessageDefinition _purpose Extensions for purpose Element
MessageDefinition copyright 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. markdown
MessageDefinition _copyright Extensions for copyright Element
MessageDefinition base The MessageDefinition that is the basis for the contents of this resource. canonical
MessageDefinition parent Identifies a protocol or workflow that this MessageDefinition represents a step in. canonical
MessageDefinition eventCoding Event code or link to the EventDefinition. Coding
MessageDefinition eventUri Event code or link to the EventDefinition. notDefined
MessageDefinition _eventUri Extensions for eventUri Element
MessageDefinition category The impact of the content of the message. enum values:
consequence
currency
notification
MessageDefinition _category Extensions for category Element
MessageDefinition focus 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
MessageDefinition responseRequired Declare at a message definition level whether a response is required or only upon error or success, or never. enum values:
always
on-error
never
on-success
MessageDefinition _responseRequired Extensions for responseRequired Element
MessageDefinition allowedResponse Indicates what types of messages may be sent as an application-level response to this message. MessageDefinition_AllowedResponse
MessageDefinition graph Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources. canonical
MessageDefinition_AllowedResponse id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MessageDefinition_AllowedResponse extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MessageDefinition_AllowedResponse modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MessageDefinition_AllowedResponse message A reference to the message definition that must be adhered to by this supported response. canonical
MessageDefinition_AllowedResponse situation Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses). markdown
MessageDefinition_AllowedResponse _situation Extensions for situation Element
MessageDefinition_Focus id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MessageDefinition_Focus extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MessageDefinition_Focus modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MessageDefinition_Focus code The kind of resource that must be the focus for this message. code
MessageDefinition_Focus _code Extensions for code Element
MessageDefinition_Focus profile A profile that reflects constraints for the focal resource (and potentially for related resources). canonical
MessageDefinition_Focus min 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. unsignedInt
MessageDefinition_Focus _min Extensions for min Element
MessageDefinition_Focus max 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. string
MessageDefinition_Focus _max Extensions for max Element
MessageHeader resourceType This is a MessageHeader resource MessageHeader
MessageHeader id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MessageHeader meta 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. Meta
MessageHeader implicitRules 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. uri
MessageHeader _implicitRules Extensions for implicitRules Element
MessageHeader language The base language in which the resource is written. code
MessageHeader _language Extensions for language Element
MessageHeader text 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. Narrative
MessageHeader contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MessageHeader extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MessageHeader modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MessageHeader eventCoding Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. Coding
MessageHeader eventUri Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. notDefined
MessageHeader _eventUri Extensions for eventUri Element
MessageHeader destination The destination application which the message is intended for. MessageHeader_Destination
MessageHeader sender Identifies the sending system to allow the use of a trust relationship. Reference
MessageHeader enterer The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Reference
MessageHeader author The logical author of the message - the person or 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. Reference
MessageHeader source The source application from which this message originated. MessageHeader_Source
MessageHeader responsible 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. Reference
MessageHeader reason Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. CodeableConcept
MessageHeader response Information about the message that this message is a response to. Only present if this message is a response. MessageHeader_Response
MessageHeader focus The actual data of the message - a reference to the root/focus class of the event. Reference
MessageHeader definition Permanent link to the MessageDefinition for this message. canonical
MessageHeader_Destination id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MessageHeader_Destination extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MessageHeader_Destination modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MessageHeader_Destination name Human-readable name for the target system. string
MessageHeader_Destination _name Extensions for name Element
MessageHeader_Destination target Identifies the target end system in situations where the initial message transmission is to an intermediary system. Reference
MessageHeader_Destination endpoint Indicates where the message should be routed to. url
MessageHeader_Destination _endpoint Extensions for endpoint Element
MessageHeader_Destination receiver Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Reference
MessageHeader_Response id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MessageHeader_Response extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MessageHeader_Response modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MessageHeader_Response identifier The MessageHeader.id of the message to which this message is a response. id
MessageHeader_Response _identifier Extensions for identifier Element
MessageHeader_Response code Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. enum values:
ok
transient-error
fatal-error
MessageHeader_Response _code Extensions for code Element
MessageHeader_Response details Full details of any issues found in the message. Reference
MessageHeader_Source id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MessageHeader_Source extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MessageHeader_Source modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MessageHeader_Source name Human-readable name for the source system. string
MessageHeader_Source _name Extensions for name Element
MessageHeader_Source software May include configuration or other information useful in debugging. string
MessageHeader_Source _software Extensions for software Element
MessageHeader_Source version Can convey versions of multiple systems in situations where a message passes through multiple hands. string
MessageHeader_Source _version Extensions for version Element
MessageHeader_Source contact An e-mail, phone, website or other contact point to use to resolve issues with message communications. ContactPoint
MessageHeader_Source endpoint Identifies the routing target to send acknowledgements to. url
MessageHeader_Source _endpoint Extensions for endpoint Element
Meta id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Meta extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Meta versionId 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. id
Meta _versionId Extensions for versionId Element
Meta lastUpdated When the resource last changed - e.g. when the version changed. instant
Meta _lastUpdated Extensions for lastUpdated Element
Meta source A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. uri
Meta _source Extensions for source Element
Meta profile A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. canonical
Meta security Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. Coding
Meta tag 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. Coding
MolecularSequence resourceType This is a MolecularSequence resource MolecularSequence
MolecularSequence id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
MolecularSequence meta 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. Meta
MolecularSequence implicitRules 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. uri
MolecularSequence _implicitRules Extensions for implicitRules Element
MolecularSequence language The base language in which the resource is written. code
MolecularSequence _language Extensions for language Element
MolecularSequence text 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. Narrative
MolecularSequence contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
MolecularSequence extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence identifier A unique identifier for this particular sequence instance. This is a FHIR-defined id. Identifier
MolecularSequence type Amino Acid Sequence/ DNA Sequence / RNA Sequence. enum values:
aa
dna
rna
MolecularSequence _type Extensions for type Element
MolecularSequence coordinateSystem Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end). integer
MolecularSequence _coordinateSystem Extensions for coordinateSystem Element
MolecularSequence patient The patient whose sequencing results are described by this resource. Reference
MolecularSequence specimen Specimen used for sequencing. Reference
MolecularSequence device The method for sequencing, for example, chip information. Reference
MolecularSequence performer The organization or lab that should be responsible for this result. Reference
MolecularSequence quantity The number of copies of the sequence of interest. (RNASeq). Quantity
MolecularSequence referenceSeq A sequence that is used as a reference to describe variants that are present in a sequence analyzed. MolecularSequence_ReferenceSeq
MolecularSequence variant The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string. MolecularSequence_Variant
MolecularSequence observedSeq Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd. string
MolecularSequence _observedSeq Extensions for observedSeq Element
MolecularSequence quality An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)). MolecularSequence_Quality
MolecularSequence readCoverage Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence. integer
MolecularSequence _readCoverage Extensions for readCoverage Element
MolecularSequence repository Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq. MolecularSequence_Repository
MolecularSequence pointer Pointer to next atomic sequence which at most contains one variant. Reference
MolecularSequence structureVariant Information about chromosome structure variation. MolecularSequence_StructureVariant
MolecularSequence_Inner id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_Inner extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_Inner modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_Inner start Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive. integer
MolecularSequence_Inner _start Extensions for start Element
MolecularSequence_Inner end Structural variant inner end. 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. integer
MolecularSequence_Inner _end Extensions for end Element
MolecularSequence_Outer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_Outer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_Outer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_Outer start Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive. integer
MolecularSequence_Outer _start Extensions for start Element
MolecularSequence_Outer end Structural variant outer end. 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. integer
MolecularSequence_Outer _end Extensions for end Element
MolecularSequence_Quality id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_Quality extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_Quality modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_Quality type INDEL / SNP / Undefined variant. enum values:
indel
snp
unknown
MolecularSequence_Quality _type Extensions for type Element
MolecularSequence_Quality standardSequence Gold standard sequence used for comparing against. CodeableConcept
MolecularSequence_Quality start Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive. integer
MolecularSequence_Quality _start Extensions for start Element
MolecularSequence_Quality end End position of the 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. integer
MolecularSequence_Quality _end Extensions for end Element
MolecularSequence_Quality score The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.org/browser/current_svn/term/SO:0001685)). Quantity
MolecularSequence_Quality method Which method is used to get sequence quality. CodeableConcept
MolecularSequence_Quality truthTP True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event. decimal
MolecularSequence_Quality _truthTP Extensions for truthTP Element
MolecularSequence_Quality queryTP True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event. decimal
MolecularSequence_Quality _queryTP Extensions for queryTP Element
MolecularSequence_Quality truthFN False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here. decimal
MolecularSequence_Quality _truthFN Extensions for truthFN Element
MolecularSequence_Quality queryFP False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here. decimal
MolecularSequence_Quality _queryFP Extensions for queryFP Element
MolecularSequence_Quality gtFP The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar). decimal
MolecularSequence_Quality _gtFP Extensions for gtFP Element
MolecularSequence_Quality precision QUERY.TP / (QUERY.TP + QUERY.FP). decimal
MolecularSequence_Quality _precision Extensions for precision Element
MolecularSequence_Quality recall TRUTH.TP / (TRUTH.TP + TRUTH.FN). decimal
MolecularSequence_Quality _recall Extensions for recall Element
MolecularSequence_Quality fScore Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall). decimal
MolecularSequence_Quality _fScore Extensions for fScore Element
MolecularSequence_Quality roc Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff. MolecularSequence_Roc
MolecularSequence_ReferenceSeq id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_ReferenceSeq extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_ReferenceSeq modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_ReferenceSeq chromosome 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)). CodeableConcept
MolecularSequence_ReferenceSeq genomeBuild The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used. string
MolecularSequence_ReferenceSeq _genomeBuild Extensions for genomeBuild Element
MolecularSequence_ReferenceSeq orientation 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. enum values:
sense
antisense
MolecularSequence_ReferenceSeq _orientation Extensions for orientation Element
MolecularSequence_ReferenceSeq referenceSeqId Reference identifier of reference sequence submitted to NCBI. It must match the type in the MolecularSequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences. CodeableConcept
MolecularSequence_ReferenceSeq referenceSeqPointer A pointer to another MolecularSequence entity as reference sequence. Reference
MolecularSequence_ReferenceSeq referenceSeqString A string like "ACGT". string
MolecularSequence_ReferenceSeq _referenceSeqString Extensions for referenceSeqString Element
MolecularSequence_ReferenceSeq strand 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. enum values:
watson
crick
MolecularSequence_ReferenceSeq _strand Extensions for strand Element
MolecularSequence_ReferenceSeq windowStart Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive. integer
MolecularSequence_ReferenceSeq _windowStart Extensions for windowStart Element
MolecularSequence_ReferenceSeq windowEnd End position of the window on the reference 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. integer
MolecularSequence_ReferenceSeq _windowEnd Extensions for windowEnd Element
MolecularSequence_Repository id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_Repository extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_Repository modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_Repository type Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource. enum values:
directlink
openapi
login
oauth
other
MolecularSequence_Repository _type Extensions for type Element
MolecularSequence_Repository url URI of an external repository which contains further details about the genetics data. uri
MolecularSequence_Repository _url Extensions for url Element
MolecularSequence_Repository name URI of an external repository which contains further details about the genetics data. string
MolecularSequence_Repository _name Extensions for name Element
MolecularSequence_Repository datasetId Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository. string
MolecularSequence_Repository _datasetId Extensions for datasetId Element
MolecularSequence_Repository variantsetId Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository. string
MolecularSequence_Repository _variantsetId Extensions for variantsetId Element
MolecularSequence_Repository readsetId Id of the read in this external repository. string
MolecularSequence_Repository _readsetId Extensions for readsetId Element
MolecularSequence_Roc id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_Roc extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_Roc modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_Roc score Invidual data point representing the GQ (genotype quality) score threshold. integer
MolecularSequence_Roc _score Extensions for score Element
MolecularSequence_Roc numTP The number of true positives if the GQ score threshold was set to "score" field value. integer
MolecularSequence_Roc _numTP Extensions for numTP Element
MolecularSequence_Roc numFP The number of false positives if the GQ score threshold was set to "score" field value. integer
MolecularSequence_Roc _numFP Extensions for numFP Element
MolecularSequence_Roc numFN The number of false negatives if the GQ score threshold was set to "score" field value. integer
MolecularSequence_Roc _numFN Extensions for numFN Element
MolecularSequence_Roc precision Calculated precision if the GQ score threshold was set to "score" field value. decimal
MolecularSequence_Roc _precision Extensions for precision Element
MolecularSequence_Roc sensitivity Calculated sensitivity if the GQ score threshold was set to "score" field value. decimal
MolecularSequence_Roc _sensitivity Extensions for sensitivity Element
MolecularSequence_Roc fMeasure Calculated fScore if the GQ score threshold was set to "score" field value. decimal
MolecularSequence_Roc _fMeasure Extensions for fMeasure Element
MolecularSequence_StructureVariant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_StructureVariant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_StructureVariant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_StructureVariant variantType Information about chromosome structure variation DNA change type. CodeableConcept
MolecularSequence_StructureVariant exact Used to indicate if the outer and inner start-end values have the same meaning. boolean
MolecularSequence_StructureVariant _exact Extensions for exact Element
MolecularSequence_StructureVariant length Length of the variant chromosome. integer
MolecularSequence_StructureVariant _length Extensions for length Element
MolecularSequence_StructureVariant outer Structural variant outer. MolecularSequence_Outer
MolecularSequence_StructureVariant inner Structural variant inner. MolecularSequence_Inner
MolecularSequence_Variant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
MolecularSequence_Variant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
MolecularSequence_Variant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
MolecularSequence_Variant start Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive. integer
MolecularSequence_Variant _start Extensions for start Element
MolecularSequence_Variant end End position of the variant on the reference 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. integer
MolecularSequence_Variant _end Extensions for end Element
MolecularSequence_Variant observedAllele An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). 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. string
MolecularSequence_Variant _observedAllele Extensions for observedAllele Element
MolecularSequence_Variant referenceAllele An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference 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. string
MolecularSequence_Variant _referenceAllele Extensions for referenceAllele Element
MolecularSequence_Variant cigar Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm). string
MolecularSequence_Variant _cigar Extensions for cigar Element
MolecularSequence_Variant variantPointer A pointer to an Observation containing variant information. Reference
Money id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Money extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Money value Numerical value (with implicit precision). decimal
Money _value Extensions for value Element
Money currency ISO 4217 Currency Code. code
Money _currency Extensions for currency Element
NamingSystem resourceType This is a NamingSystem resource NamingSystem
NamingSystem id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
NamingSystem meta 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. Meta
NamingSystem implicitRules 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. uri
NamingSystem _implicitRules Extensions for implicitRules Element
NamingSystem language The base language in which the resource is written. code
NamingSystem _language Extensions for language Element
NamingSystem text 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. Narrative
NamingSystem contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
NamingSystem extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NamingSystem modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NamingSystem name 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. string
NamingSystem _name Extensions for name Element
NamingSystem status The status of this naming system. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
NamingSystem _status Extensions for status Element
NamingSystem kind Indicates the purpose for the naming system - what kinds of things does it make unique? enum values:
codesystem
identifier
root
NamingSystem _kind Extensions for kind Element
NamingSystem date The date (and optionally time) when the naming system 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 naming system changes. dateTime
NamingSystem _date Extensions for date Element
NamingSystem publisher The name of the organization or individual that published the naming system. string
NamingSystem _publisher Extensions for publisher Element
NamingSystem contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
NamingSystem responsible The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. string
NamingSystem _responsible Extensions for responsible Element
NamingSystem type Categorizes a naming system for easier search by grouping related naming systems. CodeableConcept
NamingSystem description 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. markdown
NamingSystem _description Extensions for description Element
NamingSystem useContext 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. UsageContext
NamingSystem jurisdiction A legal or geographic region in which the naming system is intended to be used. CodeableConcept
NamingSystem usage Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. string
NamingSystem _usage Extensions for usage Element
NamingSystem uniqueId Indicates how the system may be identified when referenced in electronic exchange. NamingSystem_UniqueId
NamingSystem_UniqueId id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
NamingSystem_UniqueId extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NamingSystem_UniqueId modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NamingSystem_UniqueId type Identifies the unique identifier scheme used for this particular identifier. enum values:
oid
uuid
uri
other
NamingSystem_UniqueId _type Extensions for type Element
NamingSystem_UniqueId value The string that should be sent over the wire to identify the code system or identifier system. string
NamingSystem_UniqueId _value Extensions for value Element
NamingSystem_UniqueId preferred Indicates whether this identifier is the "preferred" identifier of this type. boolean
NamingSystem_UniqueId _preferred Extensions for preferred Element
NamingSystem_UniqueId comment Notes about the past or intended usage of this identifier. string
NamingSystem_UniqueId _comment Extensions for comment Element
NamingSystem_UniqueId period 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. Period
Narrative id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Narrative extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Narrative status 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. enum values:
generated
extensions
additional
empty
Narrative _status Extensions for status Element
Narrative div The actual narrative content, a stripped down version of XHTML. xhtml
NutritionOrder resourceType This is a NutritionOrder resource NutritionOrder
NutritionOrder id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
NutritionOrder meta 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. Meta
NutritionOrder implicitRules 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. uri
NutritionOrder _implicitRules Extensions for implicitRules Element
NutritionOrder language The base language in which the resource is written. code
NutritionOrder _language Extensions for language Element
NutritionOrder text 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. Narrative
NutritionOrder contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
NutritionOrder extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NutritionOrder modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NutritionOrder identifier Identifiers assigned to this order by the order sender or by the order receiver. Identifier
NutritionOrder instantiatesCanonical 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. canonical
NutritionOrder instantiatesUri 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. uri
NutritionOrder _instantiatesUri Extensions for instantiatesUri Element
NutritionOrder instantiates The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder. uri
NutritionOrder _instantiates Extensions for instantiates Element
NutritionOrder status The workflow status of the nutrition order/request. code
NutritionOrder _status Extensions for status Element
NutritionOrder intent Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain. code
NutritionOrder _intent Extensions for intent Element
NutritionOrder patient The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding. Reference
NutritionOrder encounter An encounter that provides additional information about the healthcare context in which this request is made. Reference
NutritionOrder dateTime The date and time that this nutrition order was requested. dateTime
NutritionOrder _dateTime Extensions for dateTime Element
NutritionOrder orderer The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings. Reference
NutritionOrder allergyIntolerance A link to a record of allergies or intolerances which should be included in the nutrition order. Reference
NutritionOrder foodPreferenceModifier 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. CodeableConcept
NutritionOrder excludeFoodModifier 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. CodeableConcept
NutritionOrder oralDiet Diet given orally in contrast to enteral (tube) feeding. NutritionOrder_OralDiet
NutritionOrder supplement Oral nutritional products given in order to add further nutritional value to the patient's diet. NutritionOrder_Supplement
NutritionOrder enteralFormula Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity. NutritionOrder_EnteralFormula
NutritionOrder note Comments made about the {{title}} by the requester, performer, subject or other participants. Annotation
NutritionOrder_Administration id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
NutritionOrder_Administration extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NutritionOrder_Administration modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NutritionOrder_Administration schedule The time period and frequency at which the enteral formula should be delivered to the patient. Timing
NutritionOrder_Administration quantity The volume of formula to provide to the patient per the specified administration schedule. Quantity
NutritionOrder_Administration rateQuantity The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule. Quantity
NutritionOrder_Administration rateRatio The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule. Ratio
NutritionOrder_EnteralFormula id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
NutritionOrder_EnteralFormula extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NutritionOrder_EnteralFormula modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NutritionOrder_EnteralFormula baseFormulaType The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula. CodeableConcept
NutritionOrder_EnteralFormula baseFormulaProductName The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula". string
NutritionOrder_EnteralFormula _baseFormulaProductName Extensions for baseFormulaProductName Element
NutritionOrder_EnteralFormula additiveType 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. CodeableConcept
NutritionOrder_EnteralFormula additiveProductName The product or brand name of the type of modular component to be added to the formula. string
NutritionOrder_EnteralFormula _additiveProductName Extensions for additiveProductName Element
NutritionOrder_EnteralFormula caloricDensity 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. Quantity
NutritionOrder_EnteralFormula routeofAdministration The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube. CodeableConcept
NutritionOrder_EnteralFormula administration 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. NutritionOrder_Administration
NutritionOrder_EnteralFormula maxVolumeToDeliver 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. Quantity
NutritionOrder_EnteralFormula administrationInstruction Free text formula administration, feeding instructions or additional instructions or information. string
NutritionOrder_EnteralFormula _administrationInstruction Extensions for administrationInstruction Element
NutritionOrder_Nutrient id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
NutritionOrder_Nutrient extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NutritionOrder_Nutrient modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NutritionOrder_Nutrient modifier The nutrient that is being modified such as carbohydrate or sodium. CodeableConcept
NutritionOrder_Nutrient amount The quantity of the specified nutrient to include in diet. Quantity
NutritionOrder_OralDiet id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
NutritionOrder_OralDiet extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NutritionOrder_OralDiet modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NutritionOrder_OralDiet type The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet. CodeableConcept
NutritionOrder_OralDiet schedule 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. Timing
NutritionOrder_OralDiet nutrient Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet. NutritionOrder_Nutrient
NutritionOrder_OralDiet texture Class that describes any texture modifications required for the patient to safely consume various types of solid foods. NutritionOrder_Texture
NutritionOrder_OralDiet fluidConsistencyType The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient. CodeableConcept
NutritionOrder_OralDiet instruction Free text or additional instructions or information pertaining to the oral diet. string
NutritionOrder_OralDiet _instruction Extensions for instruction Element
NutritionOrder_Supplement id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
NutritionOrder_Supplement extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NutritionOrder_Supplement modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NutritionOrder_Supplement type The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement. CodeableConcept
NutritionOrder_Supplement productName The product or brand name of the nutritional supplement such as "Acme Protein Shake". string
NutritionOrder_Supplement _productName Extensions for productName Element
NutritionOrder_Supplement schedule The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present. Timing
NutritionOrder_Supplement quantity The amount of the nutritional supplement to be given. Quantity
NutritionOrder_Supplement instruction Free text or additional instructions or information pertaining to the oral supplement. string
NutritionOrder_Supplement _instruction Extensions for instruction Element
NutritionOrder_Texture id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
NutritionOrder_Texture extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
NutritionOrder_Texture modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
NutritionOrder_Texture modifier Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed. CodeableConcept
NutritionOrder_Texture foodType The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types. CodeableConcept
Observation resourceType This is a Observation resource Observation
Observation id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Observation meta 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. Meta
Observation implicitRules 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. uri
Observation _implicitRules Extensions for implicitRules Element
Observation language The base language in which the resource is written. code
Observation _language Extensions for language Element
Observation text 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. Narrative
Observation contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Observation extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Observation modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Observation identifier A unique identifier assigned to this observation. Identifier
Observation basedOn 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. Reference
Observation partOf A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. Reference
Observation status The status of the result value. enum values:
registered
preliminary
final
amended
corrected
cancelled
entered-in-error
unknown
Observation _status Extensions for status Element
Observation category A code that classifies the general type of observation being made. CodeableConcept
Observation code Describes what was observed. Sometimes this is called the observation "name". CodeableConcept
Observation subject The patient, or group of patients, location, or device this observation is about and into whose 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. Reference
Observation focus 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. Reference
Observation encounter The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. Reference
Observation effectiveDateTime 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. notDefined
Observation _effectiveDateTime Extensions for effectiveDateTime Element
Observation effectivePeriod 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. Period
Observation effectiveTiming 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. Timing
Observation effectiveInstant 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. notDefined
Observation _effectiveInstant Extensions for effectiveInstant Element
Observation issued The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. instant
Observation _issued Extensions for issued Element
Observation performer Who was responsible for asserting the observed value as "true". Reference
Observation valueQuantity The information determined as a result of making the observation, if the information has a simple value. Quantity
Observation valueCodeableConcept The information determined as a result of making the observation, if the information has a simple value. CodeableConcept
Observation valueString The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation _valueString Extensions for valueString Element
Observation valueBoolean The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation _valueBoolean Extensions for valueBoolean Element
Observation valueInteger The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation _valueInteger Extensions for valueInteger Element
Observation valueRange The information determined as a result of making the observation, if the information has a simple value. Range
Observation valueRatio The information determined as a result of making the observation, if the information has a simple value. Ratio
Observation valueSampledData The information determined as a result of making the observation, if the information has a simple value. SampledData
Observation valueTime The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation _valueTime Extensions for valueTime Element
Observation valueDateTime The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation _valueDateTime Extensions for valueDateTime Element
Observation valuePeriod The information determined as a result of making the observation, if the information has a simple value. Period
Observation dataAbsentReason Provides a reason why the expected value in the element Observation.value[x] is missing. CodeableConcept
Observation interpretation A categorical assessment of an observation value. For example, high, low, normal. CodeableConcept
Observation note Comments about the observation or the results. Annotation
Observation bodySite Indicates the site on the subject's body where the observation was made (i.e. the target site). CodeableConcept
Observation method Indicates the mechanism used to perform the observation. CodeableConcept
Observation specimen The specimen that was used when this observation was made. Reference
Observation device The device used to generate the observation data. Reference
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. Observation_ReferenceRange
Observation hasMember 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. Reference
Observation derivedFrom 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. Reference
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. Observation_Component
ObservationDefinition resourceType This is a ObservationDefinition resource ObservationDefinition
ObservationDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ObservationDefinition meta 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. Meta
ObservationDefinition implicitRules 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. uri
ObservationDefinition _implicitRules Extensions for implicitRules Element
ObservationDefinition language The base language in which the resource is written. code
ObservationDefinition _language Extensions for language Element
ObservationDefinition text 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. Narrative
ObservationDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ObservationDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ObservationDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ObservationDefinition category A code that classifies the general type of observation. CodeableConcept
ObservationDefinition code Describes what will be observed. Sometimes this is called the observation "name". CodeableConcept
ObservationDefinition identifier A unique identifier assigned to this ObservationDefinition artifact. Identifier
ObservationDefinition permittedDataType The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. enum values:
Quantity
CodeableConcept
string
boolean
integer
Range
Ratio
SampledData
time
dateTime
Period
ObservationDefinition _permittedDataType Extensions for permittedDataType Element
ObservationDefinition multipleResultsAllowed Multiple results allowed for observations conforming to this ObservationDefinition. boolean
ObservationDefinition _multipleResultsAllowed Extensions for multipleResultsAllowed Element
ObservationDefinition method The method or technique used to perform the observation. CodeableConcept
ObservationDefinition preferredReportName The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. string
ObservationDefinition _preferredReportName Extensions for preferredReportName Element
ObservationDefinition quantitativeDetails Characteristics for quantitative results of this observation. ObservationDefinition_QuantitativeDetails
ObservationDefinition qualifiedInterval Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition. ObservationDefinition_QualifiedInterval
ObservationDefinition validCodedValueSet The set of valid coded results for the observations conforming to this ObservationDefinition. Reference
ObservationDefinition normalCodedValueSet The set of normal coded results for the observations conforming to this ObservationDefinition. Reference
ObservationDefinition abnormalCodedValueSet The set of abnormal coded results for the observation conforming to this ObservationDefinition. Reference
ObservationDefinition criticalCodedValueSet The set of critical coded results for the observation conforming to this ObservationDefinition. Reference
ObservationDefinition_QualifiedInterval id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ObservationDefinition_QualifiedInterval extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ObservationDefinition_QualifiedInterval modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ObservationDefinition_QualifiedInterval category The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition. enum values:
reference
critical
absolute
ObservationDefinition_QualifiedInterval _category Extensions for category Element
ObservationDefinition_QualifiedInterval range The low and high values determining the interval. There may be only one of the two. Range
ObservationDefinition_QualifiedInterval context Codes to indicate the health context the range applies to. For example, the normal or therapeutic range. CodeableConcept
ObservationDefinition_QualifiedInterval appliesTo Codes to indicate the target population this reference range applies to. CodeableConcept
ObservationDefinition_QualifiedInterval gender Sex of the population the range applies to. enum values:
male
female
other
unknown
ObservationDefinition_QualifiedInterval _gender Extensions for gender Element
ObservationDefinition_QualifiedInterval age 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. Range
ObservationDefinition_QualifiedInterval gestationalAge The gestational age to which this reference range is applicable, in the context of pregnancy. Range
ObservationDefinition_QualifiedInterval condition Text based condition for which the reference range is valid. string
ObservationDefinition_QualifiedInterval _condition Extensions for condition Element
ObservationDefinition_QuantitativeDetails id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ObservationDefinition_QuantitativeDetails extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ObservationDefinition_QuantitativeDetails modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ObservationDefinition_QuantitativeDetails customaryUnit Customary unit used to report quantitative results of observations conforming to this ObservationDefinition. CodeableConcept
ObservationDefinition_QuantitativeDetails unit SI unit used to report quantitative results of observations conforming to this ObservationDefinition. CodeableConcept
ObservationDefinition_QuantitativeDetails conversionFactor Factor for converting value expressed with SI unit to value expressed with customary unit. decimal
ObservationDefinition_QuantitativeDetails _conversionFactor Extensions for conversionFactor Element
ObservationDefinition_QuantitativeDetails decimalPrecision Number of digits after decimal separator when the results of such observations are of type Quantity. integer
ObservationDefinition_QuantitativeDetails _decimalPrecision Extensions for decimalPrecision Element
Observation_Component id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Observation_Component extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Observation_Component modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Observation_Component code Describes what was observed. Sometimes this is called the observation "code". CodeableConcept
Observation_Component valueQuantity The information determined as a result of making the observation, if the information has a simple value. Quantity
Observation_Component valueCodeableConcept The information determined as a result of making the observation, if the information has a simple value. CodeableConcept
Observation_Component valueString The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation_Component _valueString Extensions for valueString Element
Observation_Component valueBoolean The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation_Component _valueBoolean Extensions for valueBoolean Element
Observation_Component valueInteger The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation_Component _valueInteger Extensions for valueInteger Element
Observation_Component valueRange The information determined as a result of making the observation, if the information has a simple value. Range
Observation_Component valueRatio The information determined as a result of making the observation, if the information has a simple value. Ratio
Observation_Component valueSampledData The information determined as a result of making the observation, if the information has a simple value. SampledData
Observation_Component valueTime The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation_Component _valueTime Extensions for valueTime Element
Observation_Component valueDateTime The information determined as a result of making the observation, if the information has a simple value. notDefined
Observation_Component _valueDateTime Extensions for valueDateTime Element
Observation_Component valuePeriod The information determined as a result of making the observation, if the information has a simple value. Period
Observation_Component dataAbsentReason Provides a reason why the expected value in the element Observation.component.value[x] is missing. CodeableConcept
Observation_Component interpretation A categorical assessment of an observation value. For example, high, low, normal. CodeableConcept
Observation_Component referenceRange Guidance on how to interpret the value by comparison to a normal or recommended range. Observation_ReferenceRange
Observation_ReferenceRange id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Observation_ReferenceRange extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Observation_ReferenceRange modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Observation_ReferenceRange low 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). Quantity
Observation_ReferenceRange high 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). Quantity
Observation_ReferenceRange type Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. CodeableConcept
Observation_ReferenceRange appliesTo 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. CodeableConcept
Observation_ReferenceRange age 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. Range
Observation_ReferenceRange text 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". string
Observation_ReferenceRange _text Extensions for text Element
OperationDefinition resourceType This is a OperationDefinition resource OperationDefinition
OperationDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
OperationDefinition meta 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. Meta
OperationDefinition implicitRules 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. uri
OperationDefinition _implicitRules Extensions for implicitRules Element
OperationDefinition language The base language in which the resource is written. code
OperationDefinition _language Extensions for language Element
OperationDefinition text 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. Narrative
OperationDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
OperationDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OperationDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OperationDefinition url 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 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. uri
OperationDefinition _url Extensions for url Element
OperationDefinition version 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. string
OperationDefinition _version Extensions for version Element
OperationDefinition name 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. string
OperationDefinition _name Extensions for name Element
OperationDefinition title A short, descriptive, user-friendly title for the operation definition. string
OperationDefinition _title Extensions for title Element
OperationDefinition status The status of this operation definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
OperationDefinition _status Extensions for status Element
OperationDefinition kind Whether this is an operation or a named query. enum values:
operation
query
OperationDefinition _kind Extensions for kind Element
OperationDefinition experimental A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. boolean
OperationDefinition _experimental Extensions for experimental Element
OperationDefinition date The date (and optionally time) when the operation definition 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 operation definition changes. dateTime
OperationDefinition _date Extensions for date Element
OperationDefinition publisher The name of the organization or individual that published the operation definition. string
OperationDefinition _publisher Extensions for publisher Element
OperationDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
OperationDefinition description A free text natural language description of the operation definition from a consumer's perspective. markdown
OperationDefinition _description Extensions for description Element
OperationDefinition useContext 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 instances. UsageContext
OperationDefinition jurisdiction A legal or geographic region in which the operation definition is intended to be used. CodeableConcept
OperationDefinition purpose Explanation of why this operation definition is needed and why it has been designed as it has. markdown
OperationDefinition _purpose Extensions for purpose Element
OperationDefinition affectsState Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'. boolean
OperationDefinition _affectsState Extensions for affectsState Element
OperationDefinition code The name used to invoke the operation. code
OperationDefinition _code Extensions for code Element
OperationDefinition comment Additional information about how to use this operation or named query. markdown
OperationDefinition _comment Extensions for comment Element
OperationDefinition base Indicates that this operation definition is a constraining profile on the base. canonical
OperationDefinition resource The types on which this operation can be executed. code
OperationDefinition _resource Extensions for resource Element
OperationDefinition system 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). boolean
OperationDefinition _system Extensions for system Element
OperationDefinition type 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). boolean
OperationDefinition _type Extensions for type Element
OperationDefinition instance Indicates whether this operation can be invoked on a particular instance of one of the given types. boolean
OperationDefinition _instance Extensions for instance Element
OperationDefinition inputProfile 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. canonical
OperationDefinition outputProfile Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource. canonical
OperationDefinition parameter The parameters for the operation/query. OperationDefinition_Parameter
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. OperationDefinition_Overload
OperationDefinition_Binding id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
OperationDefinition_Binding extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OperationDefinition_Binding modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OperationDefinition_Binding strength 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. enum values:
required
extensible
preferred
example
OperationDefinition_Binding _strength Extensions for strength Element
OperationDefinition_Binding valueSet Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. canonical
OperationDefinition_Overload id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
OperationDefinition_Overload extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OperationDefinition_Overload modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OperationDefinition_Overload parameterName Name of parameter to include in overload. string
OperationDefinition_Overload _parameterName Extensions for parameterName Element
OperationDefinition_Overload comment Comments to go on overload. string
OperationDefinition_Overload _comment Extensions for comment Element
OperationDefinition_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
OperationDefinition_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OperationDefinition_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OperationDefinition_Parameter name The name of used to identify the parameter. code
OperationDefinition_Parameter _name Extensions for name Element
OperationDefinition_Parameter use Whether this is an input or an output parameter. enum values:
in
out
OperationDefinition_Parameter _use Extensions for use Element
OperationDefinition_Parameter min The minimum number of times this parameter SHALL appear in the request or response. integer
OperationDefinition_Parameter _min Extensions for min Element
OperationDefinition_Parameter max The maximum number of times this element is permitted to appear in the request or response. string
OperationDefinition_Parameter _max Extensions for max Element
OperationDefinition_Parameter documentation Describes the meaning or use of this parameter. string
OperationDefinition_Parameter _documentation Extensions for documentation Element
OperationDefinition_Parameter type The type for this parameter. code
OperationDefinition_Parameter _type Extensions for type Element
OperationDefinition_Parameter targetProfile 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. canonical
OperationDefinition_Parameter searchType How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'. enum values:
number
date
string
token
reference
composite
quantity
uri
special
OperationDefinition_Parameter _searchType Extensions for searchType Element
OperationDefinition_Parameter binding Binds to a value set if this parameter is coded (code, Coding, CodeableConcept). OperationDefinition_Binding
OperationDefinition_Parameter referencedFrom Identifies other resource parameters within the operation invocation that are expected to resolve to this resource. OperationDefinition_ReferencedFrom
OperationDefinition_Parameter part The parts of a nested Parameter. OperationDefinition_Parameter
OperationDefinition_ReferencedFrom id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
OperationDefinition_ReferencedFrom extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OperationDefinition_ReferencedFrom modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OperationDefinition_ReferencedFrom source 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. string
OperationDefinition_ReferencedFrom _source Extensions for source Element
OperationDefinition_ReferencedFrom sourceId The id of the element in the referencing resource that is expected to resolve to this resource. string
OperationDefinition_ReferencedFrom _sourceId Extensions for sourceId Element
OperationOutcome resourceType This is a OperationOutcome resource OperationOutcome
OperationOutcome id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
OperationOutcome meta 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. Meta
OperationOutcome implicitRules 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. uri
OperationOutcome _implicitRules Extensions for implicitRules Element
OperationOutcome language The base language in which the resource is written. code
OperationOutcome _language Extensions for language Element
OperationOutcome text 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. Narrative
OperationOutcome contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
OperationOutcome extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OperationOutcome modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OperationOutcome issue An error, warning, or information message that results from a system action. OperationOutcome_Issue
OperationOutcome_Issue id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
OperationOutcome_Issue extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OperationOutcome_Issue modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OperationOutcome_Issue severity Indicates whether the issue indicates a variation from successful processing. enum values:
fatal
error
warning
information
OperationOutcome_Issue _severity Extensions for severity Element
OperationOutcome_Issue 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. enum values:
invalid
structure
required
value
invariant
security
login
unknown
expired
forbidden
suppressed
processing
not-supported
duplicate
multiple-matches
not-found
deleted
too-long
code-invalid
extension
too-costly
business-rule
conflict
transient
lock-error
no-store
exception
timeout
incomplete
throttled
informational
OperationOutcome_Issue _code Extensions for code Element
OperationOutcome_Issue details Additional details about the error. This may be a text description of the error or a system code that identifies the error. CodeableConcept
OperationOutcome_Issue diagnostics Additional diagnostic information about the issue. string
OperationOutcome_Issue _diagnostics Extensions for diagnostics Element
OperationOutcome_Issue location 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. string
OperationOutcome_Issue _location Extensions for location Element
OperationOutcome_Issue expression 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. string
OperationOutcome_Issue _expression Extensions for expression Element
Organization resourceType This is a Organization resource Organization
Organization id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Organization meta 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. Meta
Organization implicitRules 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. uri
Organization _implicitRules Extensions for implicitRules Element
Organization language The base language in which the resource is written. code
Organization _language Extensions for language Element
Organization text 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. Narrative
Organization contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Organization extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Organization modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Organization identifier Identifier for the organization that is used to identify the organization across multiple disparate systems. Identifier
Organization active Whether the organization's record is still in active use. boolean
Organization _active Extensions for active Element
Organization type The kind(s) of organization that this is. CodeableConcept
Organization name A name associated with the organization. string
Organization _name Extensions for name Element
Organization alias A list of alternate names that the organization is known as, or was known as in the past. string
Organization _alias Extensions for alias Element
Organization telecom A contact detail for the organization. ContactPoint
Organization address An address for the organization. Address
Organization partOf The organization of which this organization forms a part. Reference
Organization contact Contact for the organization for a certain purpose. Organization_Contact
Organization endpoint Technical endpoints providing access to services operated for the organization. Reference
OrganizationAffiliation resourceType This is a OrganizationAffiliation resource OrganizationAffiliation
OrganizationAffiliation id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
OrganizationAffiliation meta 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. Meta
OrganizationAffiliation implicitRules 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. uri
OrganizationAffiliation _implicitRules Extensions for implicitRules Element
OrganizationAffiliation language The base language in which the resource is written. code
OrganizationAffiliation _language Extensions for language Element
OrganizationAffiliation text 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. Narrative
OrganizationAffiliation contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
OrganizationAffiliation extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
OrganizationAffiliation modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
OrganizationAffiliation identifier Business identifiers that are specific to this role. Identifier
OrganizationAffiliation active Whether this organization affiliation record is in active use. boolean
OrganizationAffiliation _active Extensions for active Element
OrganizationAffiliation period The period during which the participatingOrganization is affiliated with the primary organization. Period
OrganizationAffiliation organization Organization where the role is available (primary organization/has members). Reference
OrganizationAffiliation participatingOrganization 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). Reference
OrganizationAffiliation network Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). Reference
OrganizationAffiliation role Definition of the role the participatingOrganization plays in the association. CodeableConcept
OrganizationAffiliation specialty Specific specialty of the participatingOrganization in the context of the role. CodeableConcept
OrganizationAffiliation location The location(s) at which the role occurs. Reference
OrganizationAffiliation healthcareService Healthcare services provided through the role. Reference
OrganizationAffiliation telecom Contact details at the participatingOrganization relevant to this Affiliation. ContactPoint
OrganizationAffiliation endpoint Technical endpoints providing access to services operated for this role. Reference
Organization_Contact id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Organization_Contact extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Organization_Contact modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Organization_Contact purpose Indicates a purpose for which the contact can be reached. CodeableConcept
Organization_Contact name A name associated with the contact. HumanName
Organization_Contact telecom A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. ContactPoint
Organization_Contact address Visiting or postal addresses for the contact. Address
ParameterDefinition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ParameterDefinition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ParameterDefinition name The name of the parameter used to allow access to the value of the parameter in evaluation contexts. code
ParameterDefinition _name Extensions for name Element
ParameterDefinition use Whether the parameter is input or output for the module. code
ParameterDefinition _use Extensions for use Element
ParameterDefinition min The minimum number of times this parameter SHALL appear in the request or response. integer
ParameterDefinition _min Extensions for min Element
ParameterDefinition max The maximum number of times this element is permitted to appear in the request or response. string
ParameterDefinition _max Extensions for max Element
ParameterDefinition documentation A brief discussion of what the parameter is for and how it is used by the module. string
ParameterDefinition _documentation Extensions for documentation Element
ParameterDefinition type The type of the parameter. code
ParameterDefinition _type Extensions for type Element
ParameterDefinition profile If specified, this indicates a profile that the input data must conform to, or that the output data will conform to. canonical
Parameters resourceType This is a Parameters resource Parameters
Parameters id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Parameters meta 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. Meta
Parameters implicitRules 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. uri
Parameters _implicitRules Extensions for implicitRules Element
Parameters language The base language in which the resource is written. code
Parameters _language Extensions for language Element
Parameters parameter A parameter passed to or received from the operation. Parameters_Parameter
Parameters_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Parameters_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Parameters_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Parameters_Parameter name The name of the parameter (reference to the operation definition). string
Parameters_Parameter _name Extensions for name Element
Parameters_Parameter valueBase64Binary If the parameter is a data type. notDefined
Parameters_Parameter _valueBase64Binary Extensions for valueBase64Binary Element
Parameters_Parameter valueBoolean If the parameter is a data type. notDefined
Parameters_Parameter _valueBoolean Extensions for valueBoolean Element
Parameters_Parameter valueCanonical If the parameter is a data type. notDefined
Parameters_Parameter _valueCanonical Extensions for valueCanonical Element
Parameters_Parameter valueCode If the parameter is a data type. notDefined
Parameters_Parameter _valueCode Extensions for valueCode Element
Parameters_Parameter valueDate If the parameter is a data type. notDefined
Parameters_Parameter _valueDate Extensions for valueDate Element
Parameters_Parameter valueDateTime If the parameter is a data type. notDefined
Parameters_Parameter _valueDateTime Extensions for valueDateTime Element
Parameters_Parameter valueDecimal If the parameter is a data type. notDefined
Parameters_Parameter _valueDecimal Extensions for valueDecimal Element
Parameters_Parameter valueId If the parameter is a data type. notDefined
Parameters_Parameter _valueId Extensions for valueId Element
Parameters_Parameter valueInstant If the parameter is a data type. notDefined
Parameters_Parameter _valueInstant Extensions for valueInstant Element
Parameters_Parameter valueInteger If the parameter is a data type. notDefined
Parameters_Parameter _valueInteger Extensions for valueInteger Element
Parameters_Parameter valueMarkdown If the parameter is a data type. notDefined
Parameters_Parameter _valueMarkdown Extensions for valueMarkdown Element
Parameters_Parameter valueOid If the parameter is a data type. notDefined
Parameters_Parameter _valueOid Extensions for valueOid Element
Parameters_Parameter valuePositiveInt If the parameter is a data type. notDefined
Parameters_Parameter _valuePositiveInt Extensions for valuePositiveInt Element
Parameters_Parameter valueString If the parameter is a data type. notDefined
Parameters_Parameter _valueString Extensions for valueString Element
Parameters_Parameter valueTime If the parameter is a data type. notDefined
Parameters_Parameter _valueTime Extensions for valueTime Element
Parameters_Parameter valueUnsignedInt If the parameter is a data type. notDefined
Parameters_Parameter _valueUnsignedInt Extensions for valueUnsignedInt Element
Parameters_Parameter valueUri If the parameter is a data type. notDefined
Parameters_Parameter _valueUri Extensions for valueUri Element
Parameters_Parameter valueUrl If the parameter is a data type. notDefined
Parameters_Parameter _valueUrl Extensions for valueUrl Element
Parameters_Parameter valueUuid If the parameter is a data type. notDefined
Parameters_Parameter _valueUuid Extensions for valueUuid Element
Parameters_Parameter valueAddress If the parameter is a data type. Address
Parameters_Parameter valueAge If the parameter is a data type. Age
Parameters_Parameter valueAnnotation If the parameter is a data type. Annotation
Parameters_Parameter valueAttachment If the parameter is a data type. Attachment
Parameters_Parameter valueCodeableConcept If the parameter is a data type. CodeableConcept
Parameters_Parameter valueCoding If the parameter is a data type. Coding
Parameters_Parameter valueContactPoint If the parameter is a data type. ContactPoint
Parameters_Parameter valueCount If the parameter is a data type. Count
Parameters_Parameter valueDistance If the parameter is a data type. Distance
Parameters_Parameter valueDuration If the parameter is a data type. Duration
Parameters_Parameter valueHumanName If the parameter is a data type. HumanName
Parameters_Parameter valueIdentifier If the parameter is a data type. Identifier
Parameters_Parameter valueMoney If the parameter is a data type. Money
Parameters_Parameter valuePeriod If the parameter is a data type. Period
Parameters_Parameter valueQuantity If the parameter is a data type. Quantity
Parameters_Parameter valueRange If the parameter is a data type. Range
Parameters_Parameter valueRatio If the parameter is a data type. Ratio
Parameters_Parameter valueReference If the parameter is a data type. Reference
Parameters_Parameter valueSampledData If the parameter is a data type. SampledData
Parameters_Parameter valueSignature If the parameter is a data type. Signature
Parameters_Parameter valueTiming If the parameter is a data type. Timing
Parameters_Parameter valueContactDetail If the parameter is a data type. ContactDetail
Parameters_Parameter valueContributor If the parameter is a data type. Contributor
Parameters_Parameter valueDataRequirement If the parameter is a data type. DataRequirement
Parameters_Parameter valueExpression If the parameter is a data type. Expression
Parameters_Parameter valueParameterDefinition If the parameter is a data type. ParameterDefinition
Parameters_Parameter valueRelatedArtifact If the parameter is a data type. RelatedArtifact
Parameters_Parameter valueTriggerDefinition If the parameter is a data type. TriggerDefinition
Parameters_Parameter valueUsageContext If the parameter is a data type. UsageContext
Parameters_Parameter valueDosage If the parameter is a data type. Dosage
Parameters_Parameter resource If the parameter is a whole resource. ResourceList
Parameters_Parameter part A named part of a multi-part parameter. Parameters_Parameter
Patient resourceType This is a Patient resource Patient
Patient id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Patient meta 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. Meta
Patient implicitRules 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. uri
Patient _implicitRules Extensions for implicitRules Element
Patient language The base language in which the resource is written. code
Patient _language Extensions for language Element
Patient text 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. Narrative
Patient contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Patient extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Patient modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Patient identifier An identifier for this patient. Identifier
Patient active 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. boolean
Patient _active Extensions for active Element
Patient name A name associated with the individual. HumanName
Patient telecom A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. ContactPoint
Patient gender Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. enum values:
male
female
other
unknown
Patient _gender Extensions for gender Element
Patient birthDate The date of birth for the individual. date
Patient _birthDate Extensions for birthDate Element
Patient deceasedBoolean Indicates if the individual is deceased or not. notDefined
Patient _deceasedBoolean Extensions for deceasedBoolean Element
Patient deceasedDateTime Indicates if the individual is deceased or not. notDefined
Patient _deceasedDateTime Extensions for deceasedDateTime Element
Patient address An address for the individual. Address
Patient maritalStatus This field contains a patient's most recent marital (civil) status. CodeableConcept
Patient multipleBirthBoolean Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). notDefined
Patient _multipleBirthBoolean Extensions for multipleBirthBoolean Element
Patient multipleBirthInteger Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). notDefined
Patient _multipleBirthInteger Extensions for multipleBirthInteger Element
Patient photo Image of the patient. Attachment
Patient contact A contact party (e.g. guardian, partner, friend) for the patient. Patient_Contact
Patient communication A language which may be used to communicate with the patient about his or her health. Patient_Communication
Patient generalPractitioner Patient's nominated care provider. Reference
Patient managingOrganization Organization that is the custodian of the patient record. Reference
Patient link Link to another patient resource that concerns the same actual patient. Patient_Link
Patient_Communication id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Patient_Communication extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Patient_Communication modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Patient_Communication language 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-EN" for England English. CodeableConcept
Patient_Communication preferred Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). boolean
Patient_Communication _preferred Extensions for preferred Element
Patient_Contact id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Patient_Contact extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Patient_Contact modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Patient_Contact relationship The nature of the relationship between the patient and the contact person. CodeableConcept
Patient_Contact name A name associated with the contact person. HumanName
Patient_Contact telecom A contact detail for the person, e.g. a telephone number or an email address. ContactPoint
Patient_Contact address Address for the contact person. Address
Patient_Contact gender Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. enum values:
male
female
other
unknown
Patient_Contact _gender Extensions for gender Element
Patient_Contact organization Organization on behalf of which the contact is acting or for which the contact is working. Reference
Patient_Contact period The period during which this contact person or organization is valid to be contacted relating to this patient. Period
Patient_Link id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Patient_Link extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Patient_Link modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Patient_Link other The other patient resource that the link refers to. Reference
Patient_Link type The type of link between this patient resource and another patient resource. enum values:
replaced-by
replaces
refer
seealso
Patient_Link _type Extensions for type Element
PaymentNotice resourceType This is a PaymentNotice resource PaymentNotice
PaymentNotice id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
PaymentNotice meta 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. Meta
PaymentNotice implicitRules 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. uri
PaymentNotice _implicitRules Extensions for implicitRules Element
PaymentNotice language The base language in which the resource is written. code
PaymentNotice _language Extensions for language Element
PaymentNotice text 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. Narrative
PaymentNotice contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
PaymentNotice extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PaymentNotice modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PaymentNotice identifier A unique identifier assigned to this payment notice. Identifier
PaymentNotice status The status of the resource instance. code
PaymentNotice _status Extensions for status Element
PaymentNotice request Reference of resource for which payment is being made. Reference
PaymentNotice response Reference of response to resource for which payment is being made. Reference
PaymentNotice created The date when this resource was created. dateTime
PaymentNotice _created Extensions for created Element
PaymentNotice provider The practitioner who is responsible for the services rendered to the patient. Reference
PaymentNotice payment A reference to the payment which is the subject of this notice. Reference
PaymentNotice paymentDate The date when the above payment action occurred. date
PaymentNotice _paymentDate Extensions for paymentDate Element
PaymentNotice payee The party who will receive or has received payment that is the subject of this notification. Reference
PaymentNotice recipient The party who is notified of the payment status. Reference
PaymentNotice amount The amount sent to the payee. Money
PaymentNotice paymentStatus A code indicating whether payment has been sent or cleared. CodeableConcept
PaymentReconciliation resourceType This is a PaymentReconciliation resource PaymentReconciliation
PaymentReconciliation id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
PaymentReconciliation meta 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. Meta
PaymentReconciliation implicitRules 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. uri
PaymentReconciliation _implicitRules Extensions for implicitRules Element
PaymentReconciliation language The base language in which the resource is written. code
PaymentReconciliation _language Extensions for language Element
PaymentReconciliation text 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. Narrative
PaymentReconciliation contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
PaymentReconciliation extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PaymentReconciliation modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PaymentReconciliation identifier A unique identifier assigned to this payment reconciliation. Identifier
PaymentReconciliation status The status of the resource instance. code
PaymentReconciliation _status Extensions for status Element
PaymentReconciliation period The period of time for which payments have been gathered into this bulk payment for settlement. Period
PaymentReconciliation created The date when the resource was created. dateTime
PaymentReconciliation _created Extensions for created Element
PaymentReconciliation paymentIssuer The party who generated the payment. Reference
PaymentReconciliation request Original request resource reference. Reference
PaymentReconciliation requestor The practitioner who is responsible for the services rendered to the patient. Reference
PaymentReconciliation outcome The outcome of a request for a reconciliation. enum values:
queued
complete
error
partial
PaymentReconciliation _outcome Extensions for outcome Element
PaymentReconciliation disposition A human readable description of the status of the request for the reconciliation. string
PaymentReconciliation _disposition Extensions for disposition Element
PaymentReconciliation paymentDate The date of payment as indicated on the financial instrument. date
PaymentReconciliation _paymentDate Extensions for paymentDate Element
PaymentReconciliation paymentAmount Total payment amount as indicated on the financial instrument. Money
PaymentReconciliation paymentIdentifier Issuer's unique identifier for the payment instrument. Identifier
PaymentReconciliation detail Distribution of the payment amount for a previously acknowledged payable. PaymentReconciliation_Detail
PaymentReconciliation formCode A code for the form to be used for printing the content. CodeableConcept
PaymentReconciliation processNote A note that describes or explains the processing in a human readable form. PaymentReconciliation_ProcessNote
PaymentReconciliation_Detail id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PaymentReconciliation_Detail extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PaymentReconciliation_Detail modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PaymentReconciliation_Detail identifier Unique identifier for the current payment item for the referenced payable. Identifier
PaymentReconciliation_Detail predecessor Unique identifier for the prior payment item for the referenced payable. Identifier
PaymentReconciliation_Detail type Code to indicate the nature of the payment. CodeableConcept
PaymentReconciliation_Detail request A resource, such as a Claim, the evaluation of which could lead to payment. Reference
PaymentReconciliation_Detail submitter The party which submitted the claim or financial transaction. Reference
PaymentReconciliation_Detail response A resource, such as a ClaimResponse, which contains a commitment to payment. Reference
PaymentReconciliation_Detail date The date from the response resource containing a commitment to pay. date
PaymentReconciliation_Detail _date Extensions for date Element
PaymentReconciliation_Detail responsible A reference to the individual who is responsible for inquiries regarding the response and its payment. Reference
PaymentReconciliation_Detail payee The party which is receiving the payment. Reference
PaymentReconciliation_Detail amount The monetary amount allocated from the total payment to the payable. Money
PaymentReconciliation_ProcessNote id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PaymentReconciliation_ProcessNote extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PaymentReconciliation_ProcessNote modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PaymentReconciliation_ProcessNote type The business purpose of the note text. enum values:
display
print
printoper
PaymentReconciliation_ProcessNote _type Extensions for type Element
PaymentReconciliation_ProcessNote text The explanation or description associated with the processing. string
PaymentReconciliation_ProcessNote _text Extensions for text Element
Period id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Period extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Period start The start of the period. The boundary is inclusive. dateTime
Period _start Extensions for start Element
Period end 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. dateTime
Period _end Extensions for end Element
Person resourceType This is a Person resource Person
Person id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Person meta 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. Meta
Person implicitRules 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. uri
Person _implicitRules Extensions for implicitRules Element
Person language The base language in which the resource is written. code
Person _language Extensions for language Element
Person text 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. Narrative
Person contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Person extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Person modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Person identifier Identifier for a person within a particular scope. Identifier
Person name A name associated with the person. HumanName
Person telecom A contact detail for the person, e.g. a telephone number or an email address. ContactPoint
Person gender Administrative Gender. enum values:
male
female
other
unknown
Person _gender Extensions for gender Element
Person birthDate The birth date for the person. date
Person _birthDate Extensions for birthDate Element
Person address One or more addresses for the person. Address
Person photo An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. Attachment
Person managingOrganization The organization that is the custodian of the person record. Reference
Person active Whether this person's record is in active use. boolean
Person _active Extensions for active Element
Person link Link to a resource that concerns the same actual person. Person_Link
Person_Link id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Person_Link extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Person_Link modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Person_Link target The resource to which this actual person is associated. Reference
Person_Link assurance Level of assurance that this link is associated with the target resource. enum values:
level1
level2
level3
level4
Person_Link _assurance Extensions for assurance Element
PlanDefinition resourceType This is a PlanDefinition resource PlanDefinition
PlanDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
PlanDefinition meta 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. Meta
PlanDefinition implicitRules 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. uri
PlanDefinition _implicitRules Extensions for implicitRules Element
PlanDefinition language The base language in which the resource is written. code
PlanDefinition _language Extensions for language Element
PlanDefinition text 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. Narrative
PlanDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
PlanDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition url 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 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. uri
PlanDefinition _url Extensions for url Element
PlanDefinition identifier 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. Identifier
PlanDefinition version 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. string
PlanDefinition _version Extensions for version Element
PlanDefinition name 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. string
PlanDefinition _name Extensions for name Element
PlanDefinition title A short, descriptive, user-friendly title for the plan definition. string
PlanDefinition _title Extensions for title Element
PlanDefinition subtitle An explanatory or alternate title for the plan definition giving additional information about its content. string
PlanDefinition _subtitle Extensions for subtitle Element
PlanDefinition type A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. CodeableConcept
PlanDefinition status The status of this plan definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
PlanDefinition _status Extensions for status Element
PlanDefinition experimental 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. boolean
PlanDefinition _experimental Extensions for experimental Element
PlanDefinition subjectCodeableConcept A code or group definition that describes the intended subject of the plan definition. CodeableConcept
PlanDefinition subjectReference A code or group definition that describes the intended subject of the plan definition. Reference
PlanDefinition date The date (and optionally time) when the plan definition 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 plan definition changes. dateTime
PlanDefinition _date Extensions for date Element
PlanDefinition publisher The name of the organization or individual that published the plan definition. string
PlanDefinition _publisher Extensions for publisher Element
PlanDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
PlanDefinition description A free text natural language description of the plan definition from a consumer's perspective. markdown
PlanDefinition _description Extensions for description Element
PlanDefinition useContext 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. UsageContext
PlanDefinition jurisdiction A legal or geographic region in which the plan definition is intended to be used. CodeableConcept
PlanDefinition purpose Explanation of why this plan definition is needed and why it has been designed as it has. markdown
PlanDefinition _purpose Extensions for purpose Element
PlanDefinition usage A detailed description of how the plan definition is used from a clinical perspective. string
PlanDefinition _usage Extensions for usage Element
PlanDefinition copyright 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. markdown
PlanDefinition _copyright Extensions for copyright Element
PlanDefinition approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
PlanDefinition _approvalDate Extensions for approvalDate Element
PlanDefinition lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
PlanDefinition _lastReviewDate Extensions for lastReviewDate Element
PlanDefinition effectivePeriod The period during which the plan definition content was or is planned to be in active use. Period
PlanDefinition topic 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. CodeableConcept
PlanDefinition author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
PlanDefinition editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
PlanDefinition reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
PlanDefinition endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
PlanDefinition relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
PlanDefinition library A reference to a Library resource containing any formal logic used by the plan definition. canonical
PlanDefinition goal Goals that describe what the 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, etc. PlanDefinition_Goal
PlanDefinition action An action or group of actions to be taken as part of the plan. PlanDefinition_Action
PlanDefinition_Action id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PlanDefinition_Action extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition_Action modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition_Action prefix A user-visible prefix for the action. string
PlanDefinition_Action _prefix Extensions for prefix Element
PlanDefinition_Action title The title of the action displayed to a user. string
PlanDefinition_Action _title Extensions for title Element
PlanDefinition_Action description A brief description of the action used to provide a summary to display to the user. string
PlanDefinition_Action _description Extensions for description Element
PlanDefinition_Action textEquivalent 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. string
PlanDefinition_Action _textEquivalent Extensions for textEquivalent Element
PlanDefinition_Action priority Indicates how quickly the action should be addressed with respect to other actions. code
PlanDefinition_Action _priority Extensions for priority Element
PlanDefinition_Action code A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. CodeableConcept
PlanDefinition_Action reason A description of why this action is necessary or appropriate. CodeableConcept
PlanDefinition_Action documentation 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. RelatedArtifact
PlanDefinition_Action goalId Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. id
PlanDefinition_Action _goalId Extensions for goalId Element
PlanDefinition_Action subjectCodeableConcept A code or group definition that describes the intended subject of the action and its children, if any. CodeableConcept
PlanDefinition_Action subjectReference A code or group definition that describes the intended subject of the action and its children, if any. Reference
PlanDefinition_Action trigger A description of when the action should be triggered. TriggerDefinition
PlanDefinition_Action condition An expression that describes applicability criteria or start/stop conditions for the action. PlanDefinition_Condition
PlanDefinition_Action input Defines input data requirements for the action. DataRequirement
PlanDefinition_Action output Defines the outputs of the action, if any. DataRequirement
PlanDefinition_Action relatedAction A relationship to another action such as "before" or "30-60 minutes after start of". PlanDefinition_RelatedAction
PlanDefinition_Action timingDateTime An optional value describing when the action should be performed. notDefined
PlanDefinition_Action _timingDateTime Extensions for timingDateTime Element
PlanDefinition_Action timingAge An optional value describing when the action should be performed. Age
PlanDefinition_Action timingPeriod An optional value describing when the action should be performed. Period
PlanDefinition_Action timingDuration An optional value describing when the action should be performed. Duration
PlanDefinition_Action timingRange An optional value describing when the action should be performed. Range
PlanDefinition_Action timingTiming An optional value describing when the action should be performed. Timing
PlanDefinition_Action participant Indicates who should participate in performing the action described. PlanDefinition_Participant
PlanDefinition_Action type The type of action to perform (create, update, remove). CodeableConcept
PlanDefinition_Action groupingBehavior Defines the grouping behavior for the action and its children. enum values:
visual-group
logical-group
sentence-group
PlanDefinition_Action _groupingBehavior Extensions for groupingBehavior Element
PlanDefinition_Action selectionBehavior Defines the selection behavior for the action and its children. enum values:
any
all
all-or-none
exactly-one
at-most-one
one-or-more
PlanDefinition_Action _selectionBehavior Extensions for selectionBehavior Element
PlanDefinition_Action requiredBehavior Defines the required behavior for the action. enum values:
must
could
must-unless-documented
PlanDefinition_Action _requiredBehavior Extensions for requiredBehavior Element
PlanDefinition_Action precheckBehavior Defines whether the action should usually be preselected. enum values:
yes
no
PlanDefinition_Action _precheckBehavior Extensions for precheckBehavior Element
PlanDefinition_Action cardinalityBehavior Defines whether the action can be selected multiple times. enum values:
single
multiple
PlanDefinition_Action _cardinalityBehavior Extensions for cardinalityBehavior Element
PlanDefinition_Action definitionCanonical A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. notDefined
PlanDefinition_Action _definitionCanonical Extensions for definitionCanonical Element
PlanDefinition_Action definitionUri A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. notDefined
PlanDefinition_Action _definitionUri Extensions for definitionUri Element
PlanDefinition_Action transform 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. canonical
PlanDefinition_Action dynamicValue 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. PlanDefinition_DynamicValue
PlanDefinition_Action action 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. PlanDefinition_Action
PlanDefinition_Condition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PlanDefinition_Condition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition_Condition modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition_Condition kind The kind of condition. enum values:
applicability
start
stop
PlanDefinition_Condition _kind Extensions for kind Element
PlanDefinition_Condition expression An expression that returns true or false, indicating whether the condition is satisfied. Expression
PlanDefinition_DynamicValue id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PlanDefinition_DynamicValue extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition_DynamicValue modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition_DynamicValue path 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 resolveable 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). string
PlanDefinition_DynamicValue _path Extensions for path Element
PlanDefinition_DynamicValue expression An expression specifying the value of the customized element. Expression
PlanDefinition_Goal id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PlanDefinition_Goal extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition_Goal modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition_Goal category Indicates a category the goal falls within. CodeableConcept
PlanDefinition_Goal description 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". CodeableConcept
PlanDefinition_Goal priority Identifies the expected level of importance associated with reaching/sustaining the defined goal. CodeableConcept
PlanDefinition_Goal start The event after which the goal should begin being pursued. CodeableConcept
PlanDefinition_Goal addresses Identifies problems, conditions, issues, or concerns the goal is intended to address. CodeableConcept
PlanDefinition_Goal documentation 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. RelatedArtifact
PlanDefinition_Goal target Indicates what should be done and within what timeframe. PlanDefinition_Target
PlanDefinition_Participant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PlanDefinition_Participant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition_Participant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition_Participant type The type of participant in the action. enum values:
patient
practitioner
related-person
device
PlanDefinition_Participant _type Extensions for type Element
PlanDefinition_Participant role The role the participant should play in performing the described action. CodeableConcept
PlanDefinition_RelatedAction id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PlanDefinition_RelatedAction extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition_RelatedAction modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition_RelatedAction actionId The element id of the related action. id
PlanDefinition_RelatedAction _actionId Extensions for actionId Element
PlanDefinition_RelatedAction relationship The relationship of this action to the related action. enum values:
before-start
before
before-end
concurrent-with-start
concurrent
concurrent-with-end
after-start
after
after-end
PlanDefinition_RelatedAction _relationship Extensions for relationship Element
PlanDefinition_RelatedAction offsetDuration A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. Duration
PlanDefinition_RelatedAction offsetRange A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. Range
PlanDefinition_Target id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PlanDefinition_Target extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PlanDefinition_Target modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PlanDefinition_Target measure The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. CodeableConcept
PlanDefinition_Target detailQuantity The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 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 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. Quantity
PlanDefinition_Target detailRange The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 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 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. Range
PlanDefinition_Target detailCodeableConcept The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 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 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. CodeableConcept
PlanDefinition_Target due Indicates the timeframe after the start of the goal in which the goal should be met. Duration
Population id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Population extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Population modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Population ageRange The age of the specific population. Range
Population ageCodeableConcept The age of the specific population. CodeableConcept
Population gender The gender of the specific population. CodeableConcept
Population race Race of the specific population. CodeableConcept
Population physiologicalCondition The existing physiological conditions of the specific population to which this applies. CodeableConcept
Practitioner resourceType This is a Practitioner resource Practitioner
Practitioner id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Practitioner meta 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. Meta
Practitioner implicitRules 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. uri
Practitioner _implicitRules Extensions for implicitRules Element
Practitioner language The base language in which the resource is written. code
Practitioner _language Extensions for language Element
Practitioner text 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. Narrative
Practitioner contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Practitioner extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Practitioner modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Practitioner identifier An identifier that applies to this person in this role. Identifier
Practitioner active Whether this practitioner's record is in active use. boolean
Practitioner _active Extensions for active Element
Practitioner name The name(s) associated with the practitioner. HumanName
Practitioner telecom A contact detail for the practitioner, e.g. a telephone number or an email address. ContactPoint
Practitioner address 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. Address
Practitioner gender Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. enum values:
male
female
other
unknown
Practitioner _gender Extensions for gender Element
Practitioner birthDate The date of birth for the practitioner. date
Practitioner _birthDate Extensions for birthDate Element
Practitioner photo Image of the person. Attachment
Practitioner qualification The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Practitioner_Qualification
Practitioner communication A language the practitioner can use in patient communication. CodeableConcept
PractitionerRole resourceType This is a PractitionerRole resource PractitionerRole
PractitionerRole id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
PractitionerRole meta 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. Meta
PractitionerRole implicitRules 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. uri
PractitionerRole _implicitRules Extensions for implicitRules Element
PractitionerRole language The base language in which the resource is written. code
PractitionerRole _language Extensions for language Element
PractitionerRole text 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. Narrative
PractitionerRole contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
PractitionerRole extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PractitionerRole modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PractitionerRole identifier Business Identifiers that are specific to a role/location. Identifier
PractitionerRole active Whether this practitioner role record is in active use. boolean
PractitionerRole _active Extensions for active Element
PractitionerRole period The period during which the person is authorized to act as a practitioner in these role(s) for the organization. Period
PractitionerRole practitioner Practitioner that is able to provide the defined services for the organization. Reference
PractitionerRole organization The organization where the Practitioner performs the roles associated. Reference
PractitionerRole code Roles which this practitioner is authorized to perform for the organization. CodeableConcept
PractitionerRole specialty Specific specialty of the practitioner. CodeableConcept
PractitionerRole location The location(s) at which this practitioner provides care. Reference
PractitionerRole healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s). Reference
PractitionerRole telecom Contact details that are specific to the role/location/service. ContactPoint
PractitionerRole availableTime A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. PractitionerRole_AvailableTime
PractitionerRole notAvailable The practitioner is not available or performing this role during this period of time due to the provided reason. PractitionerRole_NotAvailable
PractitionerRole availabilityExceptions A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. string
PractitionerRole _availabilityExceptions Extensions for availabilityExceptions Element
PractitionerRole endpoint Technical endpoints providing access to services operated for the practitioner with this role. Reference
PractitionerRole_AvailableTime id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PractitionerRole_AvailableTime extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PractitionerRole_AvailableTime modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PractitionerRole_AvailableTime daysOfWeek Indicates which days of the week are available between the start and end Times. code
PractitionerRole_AvailableTime _daysOfWeek Extensions for daysOfWeek Element
PractitionerRole_AvailableTime allDay Is this always available? (hence times are irrelevant) e.g. 24 hour service. boolean
PractitionerRole_AvailableTime _allDay Extensions for allDay Element
PractitionerRole_AvailableTime availableStartTime The opening time of day. Note: If the AllDay flag is set, then this time is ignored. time
PractitionerRole_AvailableTime _availableStartTime Extensions for availableStartTime Element
PractitionerRole_AvailableTime availableEndTime The closing time of day. Note: If the AllDay flag is set, then this time is ignored. time
PractitionerRole_AvailableTime _availableEndTime Extensions for availableEndTime Element
PractitionerRole_NotAvailable id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
PractitionerRole_NotAvailable extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
PractitionerRole_NotAvailable modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
PractitionerRole_NotAvailable description The reason that can be presented to the user as to why this time is not available. string
PractitionerRole_NotAvailable _description Extensions for description Element
PractitionerRole_NotAvailable during Service is not available (seasonally or for a public holiday) from this date. Period
Practitioner_Qualification id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Practitioner_Qualification extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Practitioner_Qualification modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Practitioner_Qualification identifier An identifier that applies to this person's qualification in this role. Identifier
Practitioner_Qualification code Coded representation of the qualification. CodeableConcept
Practitioner_Qualification period Period during which the qualification is valid. Period
Practitioner_Qualification issuer Organization that regulates and issues the qualification. Reference
Procedure resourceType This is a Procedure resource Procedure
Procedure id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Procedure meta 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. Meta
Procedure implicitRules 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. uri
Procedure _implicitRules Extensions for implicitRules Element
Procedure language The base language in which the resource is written. code
Procedure _language Extensions for language Element
Procedure text 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. Narrative
Procedure contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Procedure extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Procedure modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Procedure identifier 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. Identifier
Procedure instantiatesCanonical 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. canonical
Procedure instantiatesUri 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. uri
Procedure _instantiatesUri Extensions for instantiatesUri Element
Procedure basedOn A reference to a resource that contains details of the request for this procedure. Reference
Procedure partOf A larger event of which this particular procedure is a component or step. Reference
Procedure status A code specifying the state of the procedure. Generally, this will be the in-progress or completed state. code
Procedure _status Extensions for status Element
Procedure statusReason Captures the reason for the current state of the procedure. CodeableConcept
Procedure category A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). CodeableConcept
Procedure code The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy"). CodeableConcept
Procedure subject The person, animal or group on which the procedure was performed. Reference
Procedure encounter The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. Reference
Procedure performedDateTime 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. notDefined
Procedure _performedDateTime Extensions for performedDateTime Element
Procedure performedPeriod 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. Period
Procedure performedString 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. notDefined
Procedure _performedString Extensions for performedString Element
Procedure performedAge 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. Age
Procedure performedRange 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. Range
Procedure recorder Individual who recorded the record and takes responsibility for its content. Reference
Procedure asserter Individual who is making the procedure statement. Reference
Procedure performer Limited to "real" people rather than equipment. Procedure_Performer
Procedure location The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. Reference
Procedure reasonCode The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text. CodeableConcept
Procedure reasonReference The justification of why the procedure was performed. Reference
Procedure bodySite Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. CodeableConcept
Procedure outcome The outcome of the procedure - did it resolve the reasons for the procedure being performed? CodeableConcept
Procedure report This could be a histology result, pathology report, surgical report, etc. Reference
Procedure complication 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. CodeableConcept
Procedure complicationDetail Any complications that occurred during the procedure, or in the immediate post-performance period. Reference
Procedure followUp 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. CodeableConcept
Procedure note Any other notes and comments about the procedure. Annotation
Procedure focalDevice 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
Procedure usedReference Identifies medications, devices and any other substance used as part of the procedure. Reference
Procedure usedCode Identifies coded items that were used as part of the procedure. CodeableConcept
Procedure_FocalDevice id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Procedure_FocalDevice extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Procedure_FocalDevice modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Procedure_FocalDevice action The kind of change that happened to the device during the procedure. CodeableConcept
Procedure_FocalDevice manipulated The device that was manipulated (changed) during the procedure. Reference
Procedure_Performer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Procedure_Performer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Procedure_Performer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Procedure_Performer function Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist. CodeableConcept
Procedure_Performer actor The practitioner who was involved in the procedure. Reference
Procedure_Performer onBehalfOf The organization the device or practitioner was acting on behalf of. Reference
ProdCharacteristic id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ProdCharacteristic extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ProdCharacteristic modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ProdCharacteristic height Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. Quantity
ProdCharacteristic width Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. Quantity
ProdCharacteristic depth Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. Quantity
ProdCharacteristic weight Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. Quantity
ProdCharacteristic nominalVolume Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. Quantity
ProdCharacteristic externalDiameter Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. Quantity
ProdCharacteristic shape Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used. string
ProdCharacteristic _shape Extensions for shape Element
ProdCharacteristic color Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used. string
ProdCharacteristic _color Extensions for color Element
ProdCharacteristic imprint Where applicable, the imprint can be specified as text. string
ProdCharacteristic _imprint Extensions for imprint Element
ProdCharacteristic image Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations. Attachment
ProdCharacteristic scoring Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used. CodeableConcept
ProductShelfLife id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ProductShelfLife extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ProductShelfLife modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ProductShelfLife identifier Unique identifier for the packaged Medicinal Product. Identifier
ProductShelfLife type This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified. CodeableConcept
ProductShelfLife period The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. Quantity
ProductShelfLife specialPrecautionsForStorage Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified. CodeableConcept
Provenance resourceType This is a Provenance resource Provenance
Provenance id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Provenance meta 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. Meta
Provenance implicitRules 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. uri
Provenance _implicitRules Extensions for implicitRules Element
Provenance language The base language in which the resource is written. code
Provenance _language Extensions for language Element
Provenance text 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. Narrative
Provenance contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Provenance extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Provenance modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Provenance target 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. Reference
Provenance occurredPeriod The period during which the activity occurred. Period
Provenance occurredDateTime The period during which the activity occurred. notDefined
Provenance _occurredDateTime Extensions for occurredDateTime Element
Provenance recorded The instant of time at which the activity was recorded. instant
Provenance _recorded Extensions for recorded Element
Provenance policy 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. uri
Provenance _policy Extensions for policy Element
Provenance location Where the activity occurred, if relevant. Reference
Provenance reason The reason that the activity was taking place. CodeableConcept
Provenance activity 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. CodeableConcept
Provenance agent An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. Provenance_Agent
Provenance entity An entity used in this activity. Provenance_Entity
Provenance signature A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. Signature
Provenance_Agent id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Provenance_Agent extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Provenance_Agent modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Provenance_Agent type The participation the agent had with respect to the activity. CodeableConcept
Provenance_Agent role The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. CodeableConcept
Provenance_Agent who The individual, device or organization that participated in the event. Reference
Provenance_Agent onBehalfOf The individual, device, or organization for whom the change was made. Reference
Provenance_Entity id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Provenance_Entity extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Provenance_Entity modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Provenance_Entity role How the entity was used during the activity. enum values:
derivation
revision
quotation
source
removal
Provenance_Entity _role Extensions for role Element
Provenance_Entity what Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. Reference
Provenance_Entity agent 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 generated the entity. Provenance_Agent
Quantity id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Quantity extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Quantity value The value of the measured amount. The value includes an implicit precision in the presentation of the value. decimal
Quantity _value Extensions for value Element
Quantity comparator 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. enum values:
<
<=
>=
>
Quantity _comparator Extensions for comparator Element
Quantity unit A human-readable form of the unit. string
Quantity _unit Extensions for unit Element
Quantity system The identification of the system that provides the coded form of the unit. uri
Quantity _system Extensions for system Element
Quantity code A computer processable form of the unit in some unit representation system. code
Quantity _code Extensions for code Element
Questionnaire resourceType This is a Questionnaire resource Questionnaire
Questionnaire id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Questionnaire meta 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. Meta
Questionnaire implicitRules 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. uri
Questionnaire _implicitRules Extensions for implicitRules Element
Questionnaire language The base language in which the resource is written. code
Questionnaire _language Extensions for language Element
Questionnaire text 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. Narrative
Questionnaire contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Questionnaire extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Questionnaire modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Questionnaire url 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 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. uri
Questionnaire _url Extensions for url Element
Questionnaire identifier 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. Identifier
Questionnaire version 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. string
Questionnaire _version Extensions for version Element
Questionnaire name 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. string
Questionnaire _name Extensions for name Element
Questionnaire title A short, descriptive, user-friendly title for the questionnaire. string
Questionnaire _title Extensions for title Element
Questionnaire derivedFrom The URL of a Questionnaire that this Questionnaire is based on. canonical
Questionnaire status The status of this questionnaire. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
Questionnaire _status Extensions for status Element
Questionnaire experimental A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. boolean
Questionnaire _experimental Extensions for experimental Element
Questionnaire subjectType The types of subjects that can be the subject of responses created for the questionnaire. code
Questionnaire _subjectType Extensions for subjectType Element
Questionnaire date The date (and optionally time) when the questionnaire 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 questionnaire changes. dateTime
Questionnaire _date Extensions for date Element
Questionnaire publisher The name of the organization or individual that published the questionnaire. string
Questionnaire _publisher Extensions for publisher Element
Questionnaire contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
Questionnaire description A free text natural language description of the questionnaire from a consumer's perspective. markdown
Questionnaire _description Extensions for description Element
Questionnaire useContext 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 questionnaire instances. UsageContext
Questionnaire jurisdiction A legal or geographic region in which the questionnaire is intended to be used. CodeableConcept
Questionnaire purpose Explanation of why this questionnaire is needed and why it has been designed as it has. markdown
Questionnaire _purpose Extensions for purpose Element
Questionnaire copyright 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. markdown
Questionnaire _copyright Extensions for copyright Element
Questionnaire approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
Questionnaire _approvalDate Extensions for approvalDate Element
Questionnaire lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
Questionnaire _lastReviewDate Extensions for lastReviewDate Element
Questionnaire effectivePeriod The period during which the questionnaire content was or is planned to be in active use. Period
Questionnaire code An identifier for this question or group of questions in a particular terminology such as LOINC. Coding
Questionnaire item A particular question, question grouping or display text that is part of the questionnaire. Questionnaire_Item
QuestionnaireResponse resourceType This is a QuestionnaireResponse resource QuestionnaireResponse
QuestionnaireResponse id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
QuestionnaireResponse meta 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. Meta
QuestionnaireResponse implicitRules 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. uri
QuestionnaireResponse _implicitRules Extensions for implicitRules Element
QuestionnaireResponse language The base language in which the resource is written. code
QuestionnaireResponse _language Extensions for language Element
QuestionnaireResponse text 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. Narrative
QuestionnaireResponse contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
QuestionnaireResponse extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
QuestionnaireResponse modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
QuestionnaireResponse identifier A business identifier assigned to a particular completed (or partially completed) questionnaire. Identifier
QuestionnaireResponse basedOn The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. Reference
QuestionnaireResponse partOf 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. Reference
QuestionnaireResponse questionnaire The Questionnaire that defines and organizes the questions for which answers are being provided. canonical
QuestionnaireResponse status The position of the questionnaire response within its overall lifecycle. enum values:
in-progress
completed
amended
entered-in-error
stopped
QuestionnaireResponse _status Extensions for status Element
QuestionnaireResponse subject 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. Reference
QuestionnaireResponse encounter The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. Reference
QuestionnaireResponse authored The date and/or time that this set of answers were last changed. dateTime
QuestionnaireResponse _authored Extensions for authored Element
QuestionnaireResponse author Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. Reference
QuestionnaireResponse source The person who answered the questions about the subject. Reference
QuestionnaireResponse item A group or question item from the original questionnaire for which answers are provided. QuestionnaireResponse_Item
QuestionnaireResponse_Answer id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
QuestionnaireResponse_Answer extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
QuestionnaireResponse_Answer modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
QuestionnaireResponse_Answer valueBoolean The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueBoolean Extensions for valueBoolean Element
QuestionnaireResponse_Answer valueDecimal The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueDecimal Extensions for valueDecimal Element
QuestionnaireResponse_Answer valueInteger The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueInteger Extensions for valueInteger Element
QuestionnaireResponse_Answer valueDate The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueDate Extensions for valueDate Element
QuestionnaireResponse_Answer valueDateTime The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueDateTime Extensions for valueDateTime Element
QuestionnaireResponse_Answer valueTime The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueTime Extensions for valueTime Element
QuestionnaireResponse_Answer valueString The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueString Extensions for valueString Element
QuestionnaireResponse_Answer valueUri The answer (or one of the answers) provided by the respondent to the question. notDefined
QuestionnaireResponse_Answer _valueUri Extensions for valueUri Element
QuestionnaireResponse_Answer valueAttachment The answer (or one of the answers) provided by the respondent to the question. Attachment
QuestionnaireResponse_Answer valueCoding The answer (or one of the answers) provided by the respondent to the question. Coding
QuestionnaireResponse_Answer valueQuantity The answer (or one of the answers) provided by the respondent to the question. Quantity
QuestionnaireResponse_Answer valueReference The answer (or one of the answers) provided by the respondent to the question. Reference
QuestionnaireResponse_Answer item Nested groups and/or questions found within this particular answer. QuestionnaireResponse_Item
QuestionnaireResponse_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
QuestionnaireResponse_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
QuestionnaireResponse_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
QuestionnaireResponse_Item linkId The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. string
QuestionnaireResponse_Item _linkId Extensions for linkId Element
QuestionnaireResponse_Item definition A reference to an [[[ElementDefinition]]] that provides the details for the item. uri
QuestionnaireResponse_Item _definition Extensions for definition Element
QuestionnaireResponse_Item text Text that is displayed above the contents of the group or as the text of the question being answered. string
QuestionnaireResponse_Item _text Extensions for text Element
QuestionnaireResponse_Item answer The respondent's answer(s) to the question. QuestionnaireResponse_Answer
QuestionnaireResponse_Item item Questions or sub-groups nested beneath a question or group. QuestionnaireResponse_Item
Questionnaire_AnswerOption id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Questionnaire_AnswerOption extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Questionnaire_AnswerOption modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Questionnaire_AnswerOption valueInteger A potential answer that's allowed as the answer to this question. notDefined
Questionnaire_AnswerOption _valueInteger Extensions for valueInteger Element
Questionnaire_AnswerOption valueDate A potential answer that's allowed as the answer to this question. notDefined
Questionnaire_AnswerOption _valueDate Extensions for valueDate Element
Questionnaire_AnswerOption valueTime A potential answer that's allowed as the answer to this question. notDefined
Questionnaire_AnswerOption _valueTime Extensions for valueTime Element
Questionnaire_AnswerOption valueString A potential answer that's allowed as the answer to this question. notDefined
Questionnaire_AnswerOption _valueString Extensions for valueString Element
Questionnaire_AnswerOption valueCoding A potential answer that's allowed as the answer to this question. Coding
Questionnaire_AnswerOption valueReference A potential answer that's allowed as the answer to this question. Reference
Questionnaire_AnswerOption initialSelected Indicates whether the answer value is selected when the list of possible answers is initially shown. boolean
Questionnaire_AnswerOption _initialSelected Extensions for initialSelected Element
Questionnaire_EnableWhen id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Questionnaire_EnableWhen extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Questionnaire_EnableWhen modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Questionnaire_EnableWhen question The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. string
Questionnaire_EnableWhen _question Extensions for question Element
Questionnaire_EnableWhen operator Specifies the criteria by which the question is enabled. enum values:
exists
=
!=
>
<
>=
<=
Questionnaire_EnableWhen _operator Extensions for operator Element
Questionnaire_EnableWhen answerBoolean A value that the referenced question is tested using the specified operator in order for the item to be enabled. notDefined
Questionnaire_EnableWhen _answerBoolean Extensions for answerBoolean Element
Questionnaire_EnableWhen answerDecimal A value that the referenced question is tested using the specified operator in order for the item to be enabled. notDefined
Questionnaire_EnableWhen _answerDecimal Extensions for answerDecimal Element
Questionnaire_EnableWhen answerInteger A value that the referenced question is tested using the specified operator in order for the item to be enabled. notDefined
Questionnaire_EnableWhen _answerInteger Extensions for answerInteger Element
Questionnaire_EnableWhen answerDate A value that the referenced question is tested using the specified operator in order for the item to be enabled. notDefined
Questionnaire_EnableWhen _answerDate Extensions for answerDate Element
Questionnaire_EnableWhen answerDateTime A value that the referenced question is tested using the specified operator in order for the item to be enabled. notDefined
Questionnaire_EnableWhen _answerDateTime Extensions for answerDateTime Element
Questionnaire_EnableWhen answerTime A value that the referenced question is tested using the specified operator in order for the item to be enabled. notDefined
Questionnaire_EnableWhen _answerTime Extensions for answerTime Element
Questionnaire_EnableWhen answerString A value that the referenced question is tested using the specified operator in order for the item to be enabled. notDefined
Questionnaire_EnableWhen _answerString Extensions for answerString Element
Questionnaire_EnableWhen answerCoding A value that the referenced question is tested using the specified operator in order for the item to be enabled. Coding
Questionnaire_EnableWhen answerQuantity A value that the referenced question is tested using the specified operator in order for the item to be enabled. Quantity
Questionnaire_EnableWhen answerReference A value that the referenced question is tested using the specified operator in order for the item to be enabled. Reference
Questionnaire_Initial id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Questionnaire_Initial extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Questionnaire_Initial modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Questionnaire_Initial valueBoolean The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueBoolean Extensions for valueBoolean Element
Questionnaire_Initial valueDecimal The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueDecimal Extensions for valueDecimal Element
Questionnaire_Initial valueInteger The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueInteger Extensions for valueInteger Element
Questionnaire_Initial valueDate The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueDate Extensions for valueDate Element
Questionnaire_Initial valueDateTime The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueDateTime Extensions for valueDateTime Element
Questionnaire_Initial valueTime The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueTime Extensions for valueTime Element
Questionnaire_Initial valueString The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueString Extensions for valueString Element
Questionnaire_Initial valueUri The actual value to for an initial answer. notDefined
Questionnaire_Initial _valueUri Extensions for valueUri Element
Questionnaire_Initial valueAttachment The actual value to for an initial answer. Attachment
Questionnaire_Initial valueCoding The actual value to for an initial answer. Coding
Questionnaire_Initial valueQuantity The actual value to for an initial answer. Quantity
Questionnaire_Initial valueReference The actual value to for an initial answer. Reference
Questionnaire_Item id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Questionnaire_Item extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Questionnaire_Item modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Questionnaire_Item linkId An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. string
Questionnaire_Item _linkId Extensions for linkId Element
Questionnaire_Item definition This element is a URI that refers to an [[[ElementDefinition]]] 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, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value: * code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * answerValueSet (ElementDefinition.binding) * options (ElementDefinition.binding). uri
Questionnaire_Item _definition Extensions for definition Element
Questionnaire_Item code A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). Coding
Questionnaire_Item prefix 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. string
Questionnaire_Item _prefix Extensions for prefix Element
Questionnaire_Item text The name of a section, the text of a question or text content for a display item. string
Questionnaire_Item _text Extensions for text Element
Questionnaire_Item type 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, coded choice, etc.). enum values:
group
display
boolean
decimal
integer
date
dateTime
time
string
text
url
choice
open-choice
attachment
reference
quantity
Questionnaire_Item _type Extensions for type Element
Questionnaire_Item enableWhen A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. Questionnaire_EnableWhen
Questionnaire_Item enableBehavior Controls how multiple enableWhen values are interpreted - whether all or any must be true. enum values:
all
any
Questionnaire_Item _enableBehavior Extensions for enableBehavior Element
Questionnaire_Item required 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. boolean
Questionnaire_Item _required Extensions for required Element
Questionnaire_Item repeats An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups. boolean
Questionnaire_Item _repeats Extensions for repeats Element
Questionnaire_Item readOnly An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. boolean
Questionnaire_Item _readOnly Extensions for readOnly Element
Questionnaire_Item maxLength The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. integer
Questionnaire_Item _maxLength Extensions for maxLength Element
Questionnaire_Item answerValueSet A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question. canonical
Questionnaire_Item answerOption One of the permitted answers for a "choice" or "open-choice" question. Questionnaire_AnswerOption
Questionnaire_Item initial One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. Questionnaire_Initial
Questionnaire_Item item Text, questions and other groups to be nested beneath a question or group. Questionnaire_Item
Range id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Range extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Range low The low limit. The boundary is inclusive. Quantity
Range high The high limit. The boundary is inclusive. Quantity
Ratio id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Ratio extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Ratio numerator The value of the numerator. Quantity
Ratio denominator The value of the denominator. Quantity
Reference id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Reference extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Reference reference 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. string
Reference _reference Extensions for reference Element
Reference type 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). uri
Reference _type Extensions for type Element
Reference identifier 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. Identifier
Reference display Plain text narrative that identifies the resource in addition to the resource reference. string
Reference _display Extensions for display Element
RelatedArtifact id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RelatedArtifact extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RelatedArtifact type The type of relationship to the related artifact. enum values:
documentation
justification
citation
predecessor
successor
derived-from
depends-on
composed-of
RelatedArtifact _type Extensions for type Element
RelatedArtifact label A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. string
RelatedArtifact _label Extensions for label Element
RelatedArtifact display A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. string
RelatedArtifact _display Extensions for display Element
RelatedArtifact citation A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. markdown
RelatedArtifact _citation Extensions for citation Element
RelatedArtifact url A url for the artifact that can be followed to access the actual content. url
RelatedArtifact _url Extensions for url Element
RelatedArtifact document The document being referenced, represented as an attachment. This is exclusive with the resource element. Attachment
RelatedArtifact resource The related resource, such as a library, value set, profile, or other knowledge resource. canonical
RelatedPerson resourceType This is a RelatedPerson resource RelatedPerson
RelatedPerson id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
RelatedPerson meta 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. Meta
RelatedPerson implicitRules 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. uri
RelatedPerson _implicitRules Extensions for implicitRules Element
RelatedPerson language The base language in which the resource is written. code
RelatedPerson _language Extensions for language Element
RelatedPerson text 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. Narrative
RelatedPerson contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
RelatedPerson extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RelatedPerson modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RelatedPerson identifier Identifier for a person within a particular scope. Identifier
RelatedPerson active Whether this related person record is in active use. boolean
RelatedPerson _active Extensions for active Element
RelatedPerson patient The patient this person is related to. Reference
RelatedPerson relationship The nature of the relationship between a patient and the related person. CodeableConcept
RelatedPerson name A name associated with the person. HumanName
RelatedPerson telecom A contact detail for the person, e.g. a telephone number or an email address. ContactPoint
RelatedPerson gender Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. enum values:
male
female
other
unknown
RelatedPerson _gender Extensions for gender Element
RelatedPerson birthDate The date on which the related person was born. date
RelatedPerson _birthDate Extensions for birthDate Element
RelatedPerson address Address where the related person can be contacted or visited. Address
RelatedPerson photo Image of the person. Attachment
RelatedPerson period The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. Period
RelatedPerson communication A language which may be used to communicate with about the patient's health. RelatedPerson_Communication
RelatedPerson_Communication id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RelatedPerson_Communication extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RelatedPerson_Communication modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RelatedPerson_Communication language 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-EN" for England English. CodeableConcept
RelatedPerson_Communication preferred Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). boolean
RelatedPerson_Communication _preferred Extensions for preferred Element
RequestGroup resourceType This is a RequestGroup resource RequestGroup
RequestGroup id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
RequestGroup meta 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. Meta
RequestGroup implicitRules 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. uri
RequestGroup _implicitRules Extensions for implicitRules Element
RequestGroup language The base language in which the resource is written. code
RequestGroup _language Extensions for language Element
RequestGroup text 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. Narrative
RequestGroup contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
RequestGroup extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RequestGroup modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RequestGroup identifier Allows a service to provide a unique, business identifier for the request. Identifier
RequestGroup instantiatesCanonical 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. canonical
RequestGroup _instantiatesCanonical Extensions for instantiatesCanonical Element
RequestGroup instantiatesUri A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. uri
RequestGroup _instantiatesUri Extensions for instantiatesUri Element
RequestGroup basedOn A plan, proposal or order that is fulfilled in whole or in part by this request. Reference
RequestGroup replaces Completed or terminated request(s) whose function is taken by this new request. Reference
RequestGroup groupIdentifier A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. Identifier
RequestGroup status The current state of the request. For request groups, the status reflects the status of all the requests in the group. code
RequestGroup _status Extensions for status Element
RequestGroup intent Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. code
RequestGroup _intent Extensions for intent Element
RequestGroup priority Indicates how quickly the request should be addressed with respect to other requests. code
RequestGroup _priority Extensions for priority Element
RequestGroup code A code that identifies what the overall request group is. CodeableConcept
RequestGroup subject The subject for which the request group was created. Reference
RequestGroup encounter Describes the context of the request group, if any. Reference
RequestGroup authoredOn Indicates when the request group was created. dateTime
RequestGroup _authoredOn Extensions for authoredOn Element
RequestGroup author Provides a reference to the author of the request group. Reference
RequestGroup reasonCode Describes the reason for the request group in coded or textual form. CodeableConcept
RequestGroup reasonReference Indicates another resource whose existence justifies this request group. Reference
RequestGroup note Provides a mechanism to communicate additional information about the response. Annotation
RequestGroup action The actions, if any, produced by the evaluation of the artifact. RequestGroup_Action
RequestGroup_Action id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RequestGroup_Action extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RequestGroup_Action modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RequestGroup_Action prefix A user-visible prefix for the action. string
RequestGroup_Action _prefix Extensions for prefix Element
RequestGroup_Action title The title of the action displayed to a user. string
RequestGroup_Action _title Extensions for title Element
RequestGroup_Action description A short description of the action used to provide a summary to display to the user. string
RequestGroup_Action _description Extensions for description Element
RequestGroup_Action textEquivalent 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. string
RequestGroup_Action _textEquivalent Extensions for textEquivalent Element
RequestGroup_Action priority Indicates how quickly the action should be addressed with respect to other actions. code
RequestGroup_Action _priority Extensions for priority Element
RequestGroup_Action 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. CodeableConcept
RequestGroup_Action documentation 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. RelatedArtifact
RequestGroup_Action condition An expression that describes applicability criteria, or start/stop conditions for the action. RequestGroup_Condition
RequestGroup_Action relatedAction A relationship to another action such as "before" or "30-60 minutes after start of". RequestGroup_RelatedAction
RequestGroup_Action timingDateTime An optional value describing when the action should be performed. notDefined
RequestGroup_Action _timingDateTime Extensions for timingDateTime Element
RequestGroup_Action timingAge An optional value describing when the action should be performed. Age
RequestGroup_Action timingPeriod An optional value describing when the action should be performed. Period
RequestGroup_Action timingDuration An optional value describing when the action should be performed. Duration
RequestGroup_Action timingRange An optional value describing when the action should be performed. Range
RequestGroup_Action timingTiming An optional value describing when the action should be performed. Timing
RequestGroup_Action participant The participant that should perform or be responsible for this action. Reference
RequestGroup_Action type The type of action to perform (create, update, remove). CodeableConcept
RequestGroup_Action groupingBehavior Defines the grouping behavior for the action and its children. code
RequestGroup_Action _groupingBehavior Extensions for groupingBehavior Element
RequestGroup_Action selectionBehavior Defines the selection behavior for the action and its children. code
RequestGroup_Action _selectionBehavior Extensions for selectionBehavior Element
RequestGroup_Action requiredBehavior Defines expectations around whether an action is required. code
RequestGroup_Action _requiredBehavior Extensions for requiredBehavior Element
RequestGroup_Action precheckBehavior Defines whether the action should usually be preselected. code
RequestGroup_Action _precheckBehavior Extensions for precheckBehavior Element
RequestGroup_Action cardinalityBehavior Defines whether the action can be selected multiple times. code
RequestGroup_Action _cardinalityBehavior Extensions for cardinalityBehavior Element
RequestGroup_Action resource The resource that is the target of the action (e.g. CommunicationRequest). Reference
RequestGroup_Action action Sub actions. RequestGroup_Action
RequestGroup_Condition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RequestGroup_Condition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RequestGroup_Condition modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RequestGroup_Condition kind The kind of condition. code
RequestGroup_Condition _kind Extensions for kind Element
RequestGroup_Condition expression An expression that returns true or false, indicating whether or not the condition is satisfied. Expression
RequestGroup_RelatedAction id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RequestGroup_RelatedAction extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RequestGroup_RelatedAction modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RequestGroup_RelatedAction actionId The element id of the action this is related to. id
RequestGroup_RelatedAction _actionId Extensions for actionId Element
RequestGroup_RelatedAction relationship The relationship of this action to the related action. code
RequestGroup_RelatedAction _relationship Extensions for relationship Element
RequestGroup_RelatedAction offsetDuration A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. Duration
RequestGroup_RelatedAction offsetRange A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. Range
ResearchDefinition resourceType This is a ResearchDefinition resource ResearchDefinition
ResearchDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ResearchDefinition meta 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. Meta
ResearchDefinition implicitRules 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. uri
ResearchDefinition _implicitRules Extensions for implicitRules Element
ResearchDefinition language The base language in which the resource is written. code
ResearchDefinition _language Extensions for language Element
ResearchDefinition text 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. Narrative
ResearchDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ResearchDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ResearchDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ResearchDefinition url An absolute URI that is used to identify this research 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 at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers. uri
ResearchDefinition _url Extensions for url Element
ResearchDefinition identifier A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Identifier
ResearchDefinition version The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research 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. string
ResearchDefinition _version Extensions for version Element
ResearchDefinition name A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. string
ResearchDefinition _name Extensions for name Element
ResearchDefinition title A short, descriptive, user-friendly title for the research definition. string
ResearchDefinition _title Extensions for title Element
ResearchDefinition shortTitle The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. string
ResearchDefinition _shortTitle Extensions for shortTitle Element
ResearchDefinition subtitle An explanatory or alternate title for the ResearchDefinition giving additional information about its content. string
ResearchDefinition _subtitle Extensions for subtitle Element
ResearchDefinition status The status of this research definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
ResearchDefinition _status Extensions for status Element
ResearchDefinition experimental A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. boolean
ResearchDefinition _experimental Extensions for experimental Element
ResearchDefinition subjectCodeableConcept The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything. CodeableConcept
ResearchDefinition subjectReference The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything. Reference
ResearchDefinition date The date (and optionally time) when the research definition 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 research definition changes. dateTime
ResearchDefinition _date Extensions for date Element
ResearchDefinition publisher The name of the organization or individual that published the research definition. string
ResearchDefinition _publisher Extensions for publisher Element
ResearchDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ResearchDefinition description A free text natural language description of the research definition from a consumer's perspective. markdown
ResearchDefinition _description Extensions for description Element
ResearchDefinition comment A human-readable string to clarify or explain concepts about the resource. string
ResearchDefinition _comment Extensions for comment Element
ResearchDefinition useContext 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 research definition instances. UsageContext
ResearchDefinition jurisdiction A legal or geographic region in which the research definition is intended to be used. CodeableConcept
ResearchDefinition purpose Explanation of why this research definition is needed and why it has been designed as it has. markdown
ResearchDefinition _purpose Extensions for purpose Element
ResearchDefinition usage A detailed description, from a clinical perspective, of how the ResearchDefinition is used. string
ResearchDefinition _usage Extensions for usage Element
ResearchDefinition copyright A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition. markdown
ResearchDefinition _copyright Extensions for copyright Element
ResearchDefinition approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
ResearchDefinition _approvalDate Extensions for approvalDate Element
ResearchDefinition lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
ResearchDefinition _lastReviewDate Extensions for lastReviewDate Element
ResearchDefinition effectivePeriod The period during which the research definition content was or is planned to be in active use. Period
ResearchDefinition topic Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching. CodeableConcept
ResearchDefinition author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
ResearchDefinition editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
ResearchDefinition reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
ResearchDefinition endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
ResearchDefinition relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
ResearchDefinition library A reference to a Library resource containing the formal logic used by the ResearchDefinition. canonical
ResearchDefinition population A reference to a ResearchElementDefinition resource that defines the population for the research. Reference
ResearchDefinition exposure A reference to a ResearchElementDefinition resource that defines the exposure for the research. Reference
ResearchDefinition exposureAlternative A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research. Reference
ResearchDefinition outcome A reference to a ResearchElementDefinition resomece that defines the outcome for the research. Reference
ResearchElementDefinition resourceType This is a ResearchElementDefinition resource ResearchElementDefinition
ResearchElementDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ResearchElementDefinition meta 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. Meta
ResearchElementDefinition implicitRules 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. uri
ResearchElementDefinition _implicitRules Extensions for implicitRules Element
ResearchElementDefinition language The base language in which the resource is written. code
ResearchElementDefinition _language Extensions for language Element
ResearchElementDefinition text 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. Narrative
ResearchElementDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ResearchElementDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ResearchElementDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ResearchElementDefinition url An absolute URI that is used to identify this research element 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 at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers. uri
ResearchElementDefinition _url Extensions for url Element
ResearchElementDefinition identifier A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Identifier
ResearchElementDefinition version The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element 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. string
ResearchElementDefinition _version Extensions for version Element
ResearchElementDefinition name A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. string
ResearchElementDefinition _name Extensions for name Element
ResearchElementDefinition title A short, descriptive, user-friendly title for the research element definition. string
ResearchElementDefinition _title Extensions for title Element
ResearchElementDefinition shortTitle The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. string
ResearchElementDefinition _shortTitle Extensions for shortTitle Element
ResearchElementDefinition subtitle An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content. string
ResearchElementDefinition _subtitle Extensions for subtitle Element
ResearchElementDefinition status The status of this research element definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
ResearchElementDefinition _status Extensions for status Element
ResearchElementDefinition experimental A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. boolean
ResearchElementDefinition _experimental Extensions for experimental Element
ResearchElementDefinition subjectCodeableConcept The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything. CodeableConcept
ResearchElementDefinition subjectReference The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything. Reference
ResearchElementDefinition date The date (and optionally time) when the research element definition 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 research element definition changes. dateTime
ResearchElementDefinition _date Extensions for date Element
ResearchElementDefinition publisher The name of the organization or individual that published the research element definition. string
ResearchElementDefinition _publisher Extensions for publisher Element
ResearchElementDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ResearchElementDefinition description A free text natural language description of the research element definition from a consumer's perspective. markdown
ResearchElementDefinition _description Extensions for description Element
ResearchElementDefinition comment A human-readable string to clarify or explain concepts about the resource. string
ResearchElementDefinition _comment Extensions for comment Element
ResearchElementDefinition useContext 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 research element definition instances. UsageContext
ResearchElementDefinition jurisdiction A legal or geographic region in which the research element definition is intended to be used. CodeableConcept
ResearchElementDefinition purpose Explanation of why this research element definition is needed and why it has been designed as it has. markdown
ResearchElementDefinition _purpose Extensions for purpose Element
ResearchElementDefinition usage A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used. string
ResearchElementDefinition _usage Extensions for usage Element
ResearchElementDefinition copyright A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition. markdown
ResearchElementDefinition _copyright Extensions for copyright Element
ResearchElementDefinition approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
ResearchElementDefinition _approvalDate Extensions for approvalDate Element
ResearchElementDefinition lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
ResearchElementDefinition _lastReviewDate Extensions for lastReviewDate Element
ResearchElementDefinition effectivePeriod The period during which the research element definition content was or is planned to be in active use. Period
ResearchElementDefinition topic Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching. CodeableConcept
ResearchElementDefinition author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
ResearchElementDefinition editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
ResearchElementDefinition reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
ResearchElementDefinition endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
ResearchElementDefinition relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
ResearchElementDefinition library A reference to a Library resource containing the formal logic used by the ResearchElementDefinition. canonical
ResearchElementDefinition type The type of research element, a population, an exposure, or an outcome. enum values:
population
exposure
outcome
ResearchElementDefinition _type Extensions for type Element
ResearchElementDefinition variableType The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive). enum values:
dichotomous
continuous
descriptive
ResearchElementDefinition _variableType Extensions for variableType Element
ResearchElementDefinition characteristic A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics. ResearchElementDefinition_Characteristic
ResearchElementDefinition_Characteristic id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ResearchElementDefinition_Characteristic extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ResearchElementDefinition_Characteristic modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ResearchElementDefinition_Characteristic definitionCodeableConcept Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). CodeableConcept
ResearchElementDefinition_Characteristic definitionCanonical Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). notDefined
ResearchElementDefinition_Characteristic _definitionCanonical Extensions for definitionCanonical Element
ResearchElementDefinition_Characteristic definitionExpression Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). Expression
ResearchElementDefinition_Characteristic definitionDataRequirement Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). DataRequirement
ResearchElementDefinition_Characteristic usageContext Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings. UsageContext
ResearchElementDefinition_Characteristic exclude When true, members with this characteristic are excluded from the element. boolean
ResearchElementDefinition_Characteristic _exclude Extensions for exclude Element
ResearchElementDefinition_Characteristic unitOfMeasure Specifies the UCUM unit for the outcome. CodeableConcept
ResearchElementDefinition_Characteristic studyEffectiveDescription A narrative description of the time period the study covers. string
ResearchElementDefinition_Characteristic _studyEffectiveDescription Extensions for studyEffectiveDescription Element
ResearchElementDefinition_Characteristic studyEffectiveDateTime Indicates what effective period the study covers. notDefined
ResearchElementDefinition_Characteristic _studyEffectiveDateTime Extensions for studyEffectiveDateTime Element
ResearchElementDefinition_Characteristic studyEffectivePeriod Indicates what effective period the study covers. Period
ResearchElementDefinition_Characteristic studyEffectiveDuration Indicates what effective period the study covers. Duration
ResearchElementDefinition_Characteristic studyEffectiveTiming Indicates what effective period the study covers. Timing
ResearchElementDefinition_Characteristic studyEffectiveTimeFromStart Indicates duration from the study initiation. Duration
ResearchElementDefinition_Characteristic studyEffectiveGroupMeasure Indicates how elements are aggregated within the study effective period. enum values:
mean
median
mean-of-mean
mean-of-median
median-of-mean
median-of-median
ResearchElementDefinition_Characteristic _studyEffectiveGroupMeasure Extensions for studyEffectiveGroupMeasure Element
ResearchElementDefinition_Characteristic participantEffectiveDescription A narrative description of the time period the study covers. string
ResearchElementDefinition_Characteristic _participantEffectiveDescription Extensions for participantEffectiveDescription Element
ResearchElementDefinition_Characteristic participantEffectiveDateTime Indicates what effective period the study covers. notDefined
ResearchElementDefinition_Characteristic _participantEffectiveDateTime Extensions for participantEffectiveDateTime Element
ResearchElementDefinition_Characteristic participantEffectivePeriod Indicates what effective period the study covers. Period
ResearchElementDefinition_Characteristic participantEffectiveDuration Indicates what effective period the study covers. Duration
ResearchElementDefinition_Characteristic participantEffectiveTiming Indicates what effective period the study covers. Timing
ResearchElementDefinition_Characteristic participantEffectiveTimeFromStart Indicates duration from the participant's study entry. Duration
ResearchElementDefinition_Characteristic participantEffectiveGroupMeasure Indicates how elements are aggregated within the study effective period. enum values:
mean
median
mean-of-mean
mean-of-median
median-of-mean
median-of-median
ResearchElementDefinition_Characteristic _participantEffectiveGroupMeasure Extensions for participantEffectiveGroupMeasure Element
ResearchStudy resourceType This is a ResearchStudy resource ResearchStudy
ResearchStudy id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ResearchStudy meta 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. Meta
ResearchStudy implicitRules 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. uri
ResearchStudy _implicitRules Extensions for implicitRules Element
ResearchStudy language The base language in which the resource is written. code
ResearchStudy _language Extensions for language Element
ResearchStudy text 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. Narrative
ResearchStudy contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ResearchStudy extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ResearchStudy modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ResearchStudy identifier Identifiers assigned to this research study by the sponsor or other systems. Identifier
ResearchStudy title A short, descriptive user-friendly label for the study. string
ResearchStudy _title Extensions for title Element
ResearchStudy protocol The set of steps expected to be performed as part of the execution of the study. Reference
ResearchStudy partOf A larger research study of which this particular study is a component or step. Reference
ResearchStudy status The current state of the study. enum values:
active
administratively-completed
approved
closed-to-accrual
closed-to-accrual-and-intervention
completed
disapproved
in-review
temporarily-closed-to-accrual
temporarily-closed-to-accrual-and-intervention
withdrawn
ResearchStudy _status Extensions for status Element
ResearchStudy primaryPurposeType The type of study based upon the intent of the study's activities. A classification of the intent of the study. CodeableConcept
ResearchStudy phase The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. CodeableConcept
ResearchStudy category Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc. CodeableConcept
ResearchStudy focus The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about. CodeableConcept
ResearchStudy condition 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. CodeableConcept
ResearchStudy contact Contact details to assist a user in learning more about or engaging with the study. ContactDetail
ResearchStudy relatedArtifact Citations, references and other related documents. RelatedArtifact
ResearchStudy keyword Key terms to aid in searching for or filtering the study. CodeableConcept
ResearchStudy location Indicates a country, state or other region where the study is taking place. CodeableConcept
ResearchStudy description A full description of how the study is being conducted. markdown
ResearchStudy _description Extensions for description Element
ResearchStudy enrollment Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes". Reference
ResearchStudy period Identifies the start date and the expected (or actual, depending on status) end date for the study. Period
ResearchStudy sponsor An organization that initiates the investigation and is legally responsible for the study. Reference
ResearchStudy principalInvestigator A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation. Reference
ResearchStudy site A facility in which study activities are conducted. Reference
ResearchStudy reasonStopped A description and/or code explaining the premature termination of the study. CodeableConcept
ResearchStudy note Comments made about the study by the performer, subject or other participants. Annotation
ResearchStudy arm Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. ResearchStudy_Arm
ResearchStudy objective 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
ResearchStudy_Arm id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ResearchStudy_Arm extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ResearchStudy_Arm modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ResearchStudy_Arm name Unique, human-readable label for this arm of the study. string
ResearchStudy_Arm _name Extensions for name Element
ResearchStudy_Arm type Categorization of study arm, e.g. experimental, active comparator, placebo comparater. CodeableConcept
ResearchStudy_Arm description A succinct description of the path through the study that would be followed by a subject adhering to this arm. string
ResearchStudy_Arm _description Extensions for description Element
ResearchStudy_Objective id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ResearchStudy_Objective extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ResearchStudy_Objective modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ResearchStudy_Objective name Unique, human-readable label for this objective of the study. string
ResearchStudy_Objective _name Extensions for name Element
ResearchStudy_Objective type The kind of study objective. CodeableConcept
ResearchSubject resourceType This is a ResearchSubject resource ResearchSubject
ResearchSubject id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ResearchSubject meta 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. Meta
ResearchSubject implicitRules 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. uri
ResearchSubject _implicitRules Extensions for implicitRules Element
ResearchSubject language The base language in which the resource is written. code
ResearchSubject _language Extensions for language Element
ResearchSubject text 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. Narrative
ResearchSubject contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ResearchSubject extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ResearchSubject modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ResearchSubject identifier Identifiers assigned to this research subject for a study. Identifier
ResearchSubject status The current state of the subject. enum values:
candidate
eligible
follow-up
ineligible
not-registered
off-study
on-study
on-study-intervention
on-study-observation
pending-on-study
potential-candidate
screening
withdrawn
ResearchSubject _status Extensions for status Element
ResearchSubject period The dates the subject began and ended their participation in the study. Period
ResearchSubject study Reference to the study the subject is participating in. Reference
ResearchSubject individual The record of the person or animal who is involved in the study. Reference
ResearchSubject assignedArm The name of the arm in the study the subject is expected to follow as part of this study. string
ResearchSubject _assignedArm Extensions for assignedArm Element
ResearchSubject actualArm The name of the arm in the study the subject actually followed as part of this study. string
ResearchSubject _actualArm Extensions for actualArm Element
ResearchSubject consent A record of the patient's informed agreement to participate in the study. Reference
RiskAssessment resourceType This is a RiskAssessment resource RiskAssessment
RiskAssessment id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
RiskAssessment meta 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. Meta
RiskAssessment implicitRules 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. uri
RiskAssessment _implicitRules Extensions for implicitRules Element
RiskAssessment language The base language in which the resource is written. code
RiskAssessment _language Extensions for language Element
RiskAssessment text 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. Narrative
RiskAssessment contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
RiskAssessment extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskAssessment modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskAssessment identifier Business identifier assigned to the risk assessment. Identifier
RiskAssessment basedOn A reference to the request that is fulfilled by this risk assessment. Reference
RiskAssessment parent A reference to a resource that this risk assessment is part of, such as a Procedure. Reference
RiskAssessment status The status of the RiskAssessment, using the same statuses as an Observation. code
RiskAssessment _status Extensions for status Element
RiskAssessment method The algorithm, process or mechanism used to evaluate the risk. CodeableConcept
RiskAssessment code The type of the risk assessment performed. CodeableConcept
RiskAssessment subject The patient or group the risk assessment applies to. Reference
RiskAssessment encounter The encounter where the assessment was performed. Reference
RiskAssessment occurrenceDateTime The date (and possibly time) the risk assessment was performed. notDefined
RiskAssessment _occurrenceDateTime Extensions for occurrenceDateTime Element
RiskAssessment occurrencePeriod The date (and possibly time) the risk assessment was performed. Period
RiskAssessment condition For assessments or prognosis specific to a particular condition, indicates the condition being assessed. Reference
RiskAssessment performer The provider or software application that performed the assessment. Reference
RiskAssessment reasonCode The reason the risk assessment was performed. CodeableConcept
RiskAssessment reasonReference Resources supporting the reason the risk assessment was performed. Reference
RiskAssessment basis Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.). Reference
RiskAssessment prediction Describes the expected outcome for the subject. RiskAssessment_Prediction
RiskAssessment mitigation A description of the steps that might be taken to reduce the identified risk(s). string
RiskAssessment _mitigation Extensions for mitigation Element
RiskAssessment note Additional comments about the risk assessment. Annotation
RiskAssessment_Prediction id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RiskAssessment_Prediction extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskAssessment_Prediction modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskAssessment_Prediction outcome One of the potential outcomes for the patient (e.g. remission, death, a particular condition). CodeableConcept
RiskAssessment_Prediction probabilityDecimal Indicates how likely the outcome is (in the specified timeframe). notDefined
RiskAssessment_Prediction _probabilityDecimal Extensions for probabilityDecimal Element
RiskAssessment_Prediction probabilityRange Indicates how likely the outcome is (in the specified timeframe). Range
RiskAssessment_Prediction qualitativeRisk Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high). CodeableConcept
RiskAssessment_Prediction relativeRisk 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.). decimal
RiskAssessment_Prediction _relativeRisk Extensions for relativeRisk Element
RiskAssessment_Prediction whenPeriod Indicates the period of time or age range of the subject to which the specified probability applies. Period
RiskAssessment_Prediction whenRange Indicates the period of time or age range of the subject to which the specified probability applies. Range
RiskAssessment_Prediction rationale Additional information explaining the basis for the prediction. string
RiskAssessment_Prediction _rationale Extensions for rationale Element
RiskEvidenceSynthesis resourceType This is a RiskEvidenceSynthesis resource RiskEvidenceSynthesis
RiskEvidenceSynthesis id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
RiskEvidenceSynthesis meta 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. Meta
RiskEvidenceSynthesis implicitRules 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. uri
RiskEvidenceSynthesis _implicitRules Extensions for implicitRules Element
RiskEvidenceSynthesis language The base language in which the resource is written. code
RiskEvidenceSynthesis _language Extensions for language Element
RiskEvidenceSynthesis text 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. Narrative
RiskEvidenceSynthesis contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
RiskEvidenceSynthesis extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskEvidenceSynthesis modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskEvidenceSynthesis url An absolute URI that is used to identify this risk evidence synthesis 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 at which an authoritative instance of this risk evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the risk evidence synthesis is stored on different servers. uri
RiskEvidenceSynthesis _url Extensions for url Element
RiskEvidenceSynthesis identifier A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance. Identifier
RiskEvidenceSynthesis version The identifier that is used to identify this version of the risk evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the risk evidence synthesis 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. string
RiskEvidenceSynthesis _version Extensions for version Element
RiskEvidenceSynthesis name A natural language name identifying the risk evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation. string
RiskEvidenceSynthesis _name Extensions for name Element
RiskEvidenceSynthesis title A short, descriptive, user-friendly title for the risk evidence synthesis. string
RiskEvidenceSynthesis _title Extensions for title Element
RiskEvidenceSynthesis status The status of this risk evidence synthesis. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
RiskEvidenceSynthesis _status Extensions for status Element
RiskEvidenceSynthesis date The date (and optionally time) when the risk evidence synthesis 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 risk evidence synthesis changes. dateTime
RiskEvidenceSynthesis _date Extensions for date Element
RiskEvidenceSynthesis publisher The name of the organization or individual that published the risk evidence synthesis. string
RiskEvidenceSynthesis _publisher Extensions for publisher Element
RiskEvidenceSynthesis contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
RiskEvidenceSynthesis description A free text natural language description of the risk evidence synthesis from a consumer's perspective. markdown
RiskEvidenceSynthesis _description Extensions for description Element
RiskEvidenceSynthesis note A human-readable string to clarify or explain concepts about the resource. Annotation
RiskEvidenceSynthesis useContext 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 risk evidence synthesis instances. UsageContext
RiskEvidenceSynthesis jurisdiction A legal or geographic region in which the risk evidence synthesis is intended to be used. CodeableConcept
RiskEvidenceSynthesis copyright A copyright statement relating to the risk evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the risk evidence synthesis. markdown
RiskEvidenceSynthesis _copyright Extensions for copyright Element
RiskEvidenceSynthesis approvalDate The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. date
RiskEvidenceSynthesis _approvalDate Extensions for approvalDate Element
RiskEvidenceSynthesis lastReviewDate The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. date
RiskEvidenceSynthesis _lastReviewDate Extensions for lastReviewDate Element
RiskEvidenceSynthesis effectivePeriod The period during which the risk evidence synthesis content was or is planned to be in active use. Period
RiskEvidenceSynthesis topic Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching. CodeableConcept
RiskEvidenceSynthesis author An individiual or organization primarily involved in the creation and maintenance of the content. ContactDetail
RiskEvidenceSynthesis editor An individual or organization primarily responsible for internal coherence of the content. ContactDetail
RiskEvidenceSynthesis reviewer An individual or organization primarily responsible for review of some aspect of the content. ContactDetail
RiskEvidenceSynthesis endorser An individual or organization responsible for officially endorsing the content for use in some setting. ContactDetail
RiskEvidenceSynthesis relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references. RelatedArtifact
RiskEvidenceSynthesis synthesisType Type of synthesis eg meta-analysis. CodeableConcept
RiskEvidenceSynthesis studyType Type of study eg randomized trial. CodeableConcept
RiskEvidenceSynthesis population A reference to a EvidenceVariable resource that defines the population for the research. Reference
RiskEvidenceSynthesis exposure A reference to a EvidenceVariable resource that defines the exposure for the research. Reference
RiskEvidenceSynthesis outcome A reference to a EvidenceVariable resomece that defines the outcome for the research. Reference
RiskEvidenceSynthesis sampleSize A description of the size of the sample involved in the synthesis. RiskEvidenceSynthesis_SampleSize
RiskEvidenceSynthesis riskEstimate The estimated risk of the outcome. RiskEvidenceSynthesis_RiskEstimate
RiskEvidenceSynthesis certainty A description of the certainty of the risk estimate. RiskEvidenceSynthesis_Certainty
RiskEvidenceSynthesis_Certainty id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RiskEvidenceSynthesis_Certainty extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskEvidenceSynthesis_Certainty modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskEvidenceSynthesis_Certainty rating A rating of the certainty of the effect estimate. CodeableConcept
RiskEvidenceSynthesis_Certainty note A human-readable string to clarify or explain concepts about the resource. Annotation
RiskEvidenceSynthesis_Certainty certaintySubcomponent A description of a component of the overall certainty. RiskEvidenceSynthesis_CertaintySubcomponent
RiskEvidenceSynthesis_CertaintySubcomponent id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RiskEvidenceSynthesis_CertaintySubcomponent extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskEvidenceSynthesis_CertaintySubcomponent modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskEvidenceSynthesis_CertaintySubcomponent type Type of subcomponent of certainty rating. CodeableConcept
RiskEvidenceSynthesis_CertaintySubcomponent rating A rating of a subcomponent of rating certainty. CodeableConcept
RiskEvidenceSynthesis_CertaintySubcomponent note A human-readable string to clarify or explain concepts about the resource. Annotation
RiskEvidenceSynthesis_PrecisionEstimate id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RiskEvidenceSynthesis_PrecisionEstimate extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskEvidenceSynthesis_PrecisionEstimate modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskEvidenceSynthesis_PrecisionEstimate type Examples include confidence interval and interquartile range. CodeableConcept
RiskEvidenceSynthesis_PrecisionEstimate level Use 95 for a 95% confidence interval. decimal
RiskEvidenceSynthesis_PrecisionEstimate _level Extensions for level Element
RiskEvidenceSynthesis_PrecisionEstimate from Lower bound of confidence interval. decimal
RiskEvidenceSynthesis_PrecisionEstimate _from Extensions for from Element
RiskEvidenceSynthesis_PrecisionEstimate to Upper bound of confidence interval. decimal
RiskEvidenceSynthesis_PrecisionEstimate _to Extensions for to Element
RiskEvidenceSynthesis_RiskEstimate id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RiskEvidenceSynthesis_RiskEstimate extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskEvidenceSynthesis_RiskEstimate modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskEvidenceSynthesis_RiskEstimate description Human-readable summary of risk estimate. string
RiskEvidenceSynthesis_RiskEstimate _description Extensions for description Element
RiskEvidenceSynthesis_RiskEstimate type Examples include proportion and mean. CodeableConcept
RiskEvidenceSynthesis_RiskEstimate value The point estimate of the risk estimate. decimal
RiskEvidenceSynthesis_RiskEstimate _value Extensions for value Element
RiskEvidenceSynthesis_RiskEstimate unitOfMeasure Specifies the UCUM unit for the outcome. CodeableConcept
RiskEvidenceSynthesis_RiskEstimate denominatorCount The sample size for the group that was measured for this risk estimate. integer
RiskEvidenceSynthesis_RiskEstimate _denominatorCount Extensions for denominatorCount Element
RiskEvidenceSynthesis_RiskEstimate numeratorCount The number of group members with the outcome of interest. integer
RiskEvidenceSynthesis_RiskEstimate _numeratorCount Extensions for numeratorCount Element
RiskEvidenceSynthesis_RiskEstimate precisionEstimate A description of the precision of the estimate for the effect. RiskEvidenceSynthesis_PrecisionEstimate
RiskEvidenceSynthesis_SampleSize id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
RiskEvidenceSynthesis_SampleSize extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
RiskEvidenceSynthesis_SampleSize modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
RiskEvidenceSynthesis_SampleSize description Human-readable summary of sample size. string
RiskEvidenceSynthesis_SampleSize _description Extensions for description Element
RiskEvidenceSynthesis_SampleSize numberOfStudies Number of studies included in this evidence synthesis. integer
RiskEvidenceSynthesis_SampleSize _numberOfStudies Extensions for numberOfStudies Element
RiskEvidenceSynthesis_SampleSize numberOfParticipants Number of participants included in this evidence synthesis. integer
RiskEvidenceSynthesis_SampleSize _numberOfParticipants Extensions for numberOfParticipants Element
SampledData id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SampledData extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SampledData origin The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series. Quantity
SampledData period The length of time between sampling times, measured in milliseconds. decimal
SampledData _period Extensions for period Element
SampledData factor A correction factor that is applied to the sampled data points before they are added to the origin. decimal
SampledData _factor Extensions for factor Element
SampledData lowerLimit 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). decimal
SampledData _lowerLimit Extensions for lowerLimit Element
SampledData upperLimit 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). decimal
SampledData _upperLimit Extensions for upperLimit Element
SampledData dimensions 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. positiveInt
SampledData _dimensions Extensions for dimensions Element
SampledData data A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value. string
SampledData _data Extensions for data Element
Schedule resourceType This is a Schedule resource Schedule
Schedule id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Schedule meta 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. Meta
Schedule implicitRules 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. uri
Schedule _implicitRules Extensions for implicitRules Element
Schedule language The base language in which the resource is written. code
Schedule _language Extensions for language Element
Schedule text 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. Narrative
Schedule contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Schedule extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Schedule modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Schedule identifier External Ids for this item. Identifier
Schedule active Whether this schedule record is in active use or should not be used (such as was entered in error). boolean
Schedule _active Extensions for active Element
Schedule serviceCategory A broad categorization of the service that is to be performed during this appointment. CodeableConcept
Schedule serviceType The specific service that is to be performed during this appointment. CodeableConcept
Schedule specialty The specialty of a practitioner that would be required to perform the service requested in this appointment. CodeableConcept
Schedule actor Slots that reference this schedule resource provide the availability details to these referenced resource(s). Reference
Schedule planningHorizon 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. Period
Schedule comment Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. string
Schedule _comment Extensions for comment Element
SearchParameter resourceType This is a SearchParameter resource SearchParameter
SearchParameter id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SearchParameter meta 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. Meta
SearchParameter implicitRules 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. uri
SearchParameter _implicitRules Extensions for implicitRules Element
SearchParameter language The base language in which the resource is written. code
SearchParameter _language Extensions for language Element
SearchParameter text 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. Narrative
SearchParameter contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SearchParameter extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SearchParameter modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SearchParameter url 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 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. uri
SearchParameter _url Extensions for url Element
SearchParameter version 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. string
SearchParameter _version Extensions for version Element
SearchParameter name 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. string
SearchParameter _name Extensions for name Element
SearchParameter derivedFrom 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. canonical
SearchParameter status The status of this search parameter. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
SearchParameter _status Extensions for status Element
SearchParameter experimental 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. boolean
SearchParameter _experimental Extensions for experimental Element
SearchParameter date The date (and optionally time) when the search parameter 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 search parameter changes. dateTime
SearchParameter _date Extensions for date Element
SearchParameter publisher The name of the organization or individual that published the search parameter. string
SearchParameter _publisher Extensions for publisher Element
SearchParameter contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
SearchParameter description And how it used. markdown
SearchParameter _description Extensions for description Element
SearchParameter useContext 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. UsageContext
SearchParameter jurisdiction A legal or geographic region in which the search parameter is intended to be used. CodeableConcept
SearchParameter purpose Explanation of why this search parameter is needed and why it has been designed as it has. markdown
SearchParameter _purpose Extensions for purpose Element
SearchParameter code The code used in the URL or the parameter name in a parameters resource for this search parameter. code
SearchParameter _code Extensions for code Element
SearchParameter base The base resource type(s) that this search parameter can be used against. code
SearchParameter _base Extensions for base Element
SearchParameter type The type of value that a search parameter may contain, and how the content is interpreted. enum values:
number
date
string
token
reference
composite
quantity
uri
special
SearchParameter _type Extensions for type Element
SearchParameter expression A FHIRPath expression that returns a set of elements for the search parameter. string
SearchParameter _expression Extensions for expression Element
SearchParameter xpath An XPath expression that returns a set of elements for the search parameter. string
SearchParameter _xpath Extensions for xpath Element
SearchParameter xpathUsage How the search parameter relates to the set of elements returned by evaluating the xpath query. enum values:
normal
phonetic
nearby
distance
other
SearchParameter _xpathUsage Extensions for xpathUsage Element
SearchParameter target Types of resource (if a resource is referenced). code
SearchParameter _target Extensions for target Element
SearchParameter multipleOr 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. boolean
SearchParameter _multipleOr Extensions for multipleOr Element
SearchParameter multipleAnd Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match. boolean
SearchParameter _multipleAnd Extensions for multipleAnd Element
SearchParameter comparator Comparators supported for the search parameter. enum values:
eq
ne
gt
lt
ge
le
sa
eb
ap
SearchParameter _comparator Extensions for comparator Element
SearchParameter modifier A modifier supported for the search parameter. enum values:
missing
exact
contains
not
text
in
not-in
below
above
type
identifier
ofType
SearchParameter _modifier Extensions for modifier Element
SearchParameter chain 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. string
SearchParameter _chain Extensions for chain Element
SearchParameter component Used to define the parts of a composite search parameter. SearchParameter_Component
SearchParameter_Component id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SearchParameter_Component extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SearchParameter_Component modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SearchParameter_Component definition The definition of the search parameter that describes this part. canonical
SearchParameter_Component expression A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression. string
SearchParameter_Component _expression Extensions for expression Element
ServiceRequest resourceType This is a ServiceRequest resource ServiceRequest
ServiceRequest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ServiceRequest meta 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. Meta
ServiceRequest implicitRules 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. uri
ServiceRequest _implicitRules Extensions for implicitRules Element
ServiceRequest language The base language in which the resource is written. code
ServiceRequest _language Extensions for language Element
ServiceRequest text 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. Narrative
ServiceRequest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ServiceRequest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ServiceRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ServiceRequest identifier Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. Identifier
ServiceRequest instantiatesCanonical 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. canonical
ServiceRequest instantiatesUri 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. uri
ServiceRequest _instantiatesUri Extensions for instantiatesUri Element
ServiceRequest basedOn Plan/proposal/order fulfilled by this request. Reference
ServiceRequest replaces The request takes the place of the referenced completed or terminated request(s). Reference
ServiceRequest requisition 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. Identifier
ServiceRequest status The status of the order. code
ServiceRequest _status Extensions for status Element
ServiceRequest intent Whether the request is a proposal, plan, an original order or a reflex order. code
ServiceRequest _intent Extensions for intent Element
ServiceRequest category A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). CodeableConcept
ServiceRequest priority Indicates how quickly the ServiceRequest should be addressed with respect to other requests. code
ServiceRequest _priority Extensions for priority Element
ServiceRequest doNotPerform Set this to true if the record is saying that the service/procedure should NOT be performed. boolean
ServiceRequest _doNotPerform Extensions for doNotPerform Element
ServiceRequest code A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. CodeableConcept
ServiceRequest orderDetail 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. CodeableConcept
ServiceRequest quantityQuantity 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). Quantity
ServiceRequest quantityRatio 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). Ratio
ServiceRequest quantityRange 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). Range
ServiceRequest subject 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). Reference
ServiceRequest encounter An encounter that provides additional information about the healthcare context in which this request is made. Reference
ServiceRequest occurrenceDateTime The date/time at which the requested service should occur. notDefined
ServiceRequest _occurrenceDateTime Extensions for occurrenceDateTime Element
ServiceRequest occurrencePeriod The date/time at which the requested service should occur. Period
ServiceRequest occurrenceTiming The date/time at which the requested service should occur. Timing
ServiceRequest asNeededBoolean If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. notDefined
ServiceRequest _asNeededBoolean Extensions for asNeededBoolean Element
ServiceRequest asNeededCodeableConcept If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. CodeableConcept
ServiceRequest authoredOn When the request transitioned to being actionable. dateTime
ServiceRequest _authoredOn Extensions for authoredOn Element
ServiceRequest requester The individual who initiated the request and has responsibility for its activation. Reference
ServiceRequest performerType Desired type of performer for doing the requested service. CodeableConcept
ServiceRequest performer The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. Reference
ServiceRequest locationCode 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. CodeableConcept
ServiceRequest locationReference A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. Reference
ServiceRequest reasonCode 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`. CodeableConcept
ServiceRequest reasonReference Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. Reference
ServiceRequest insurance Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. Reference
ServiceRequest supportingInfo 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. Reference
ServiceRequest specimen One or more specimens that the laboratory procedure will use. Reference
ServiceRequest bodySite Anatomic location where the procedure should be performed. This is the target site. CodeableConcept
ServiceRequest note Any other notes and comments made about the service request. For example, internal billing notes. Annotation
ServiceRequest patientInstruction Instructions in terms that are understood by the patient or consumer. string
ServiceRequest _patientInstruction Extensions for patientInstruction Element
ServiceRequest relevantHistory Key events in the history of the request. Reference
Signature id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Signature extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Signature type 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. Coding
Signature when When the digital signature was signed. instant
Signature _when Extensions for when Element
Signature who A reference to an application-usable description of the identity that signed (e.g. the signature used their private key). Reference
Signature onBehalfOf A reference to an application-usable description of the identity that is represented by the signature. Reference
Signature targetFormat A mime type that indicates the technical format of the target resources signed by the signature. code
Signature _targetFormat Extensions for targetFormat Element
Signature sigFormat 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. code
Signature _sigFormat Extensions for sigFormat Element
Signature data The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. base64Binary
Signature _data Extensions for data Element
Slot resourceType This is a Slot resource Slot
Slot id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Slot meta 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. Meta
Slot implicitRules 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. uri
Slot _implicitRules Extensions for implicitRules Element
Slot language The base language in which the resource is written. code
Slot _language Extensions for language Element
Slot text 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. Narrative
Slot contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Slot extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Slot modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Slot identifier External Ids for this item. Identifier
Slot serviceCategory A broad categorization of the service that is to be performed during this appointment. CodeableConcept
Slot serviceType 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 availability resource. CodeableConcept
Slot specialty The specialty of a practitioner that would be required to perform the service requested in this appointment. CodeableConcept
Slot appointmentType The style of appointment or patient that may be booked in the slot (not service type). CodeableConcept
Slot schedule The schedule resource that this slot defines an interval of status information. Reference
Slot status busy | free | busy-unavailable | busy-tentative | entered-in-error. enum values:
busy
free
busy-unavailable
busy-tentative
entered-in-error
Slot _status Extensions for status Element
Slot start Date/Time that the slot is to begin. instant
Slot _start Extensions for start Element
Slot end Date/Time that the slot is to conclude. instant
Slot _end Extensions for end Element
Slot overbooked This slot has already been overbooked, appointments are unlikely to be accepted for this time. boolean
Slot _overbooked Extensions for overbooked Element
Slot comment Comments on the slot to describe any extended information. Such as custom constraints on the slot. string
Slot _comment Extensions for comment Element
Specimen resourceType This is a Specimen resource Specimen
Specimen id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Specimen meta 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. Meta
Specimen implicitRules 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. uri
Specimen _implicitRules Extensions for implicitRules Element
Specimen language The base language in which the resource is written. code
Specimen _language Extensions for language Element
Specimen text 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. Narrative
Specimen contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Specimen extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Specimen modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Specimen identifier Id for specimen. Identifier
Specimen accessionIdentifier 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. Identifier
Specimen status The availability of the specimen. enum values:
available
unavailable
unsatisfactory
entered-in-error
Specimen _status Extensions for status Element
Specimen type The kind of material that forms the specimen. CodeableConcept
Specimen subject 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 or a device. Reference
Specimen receivedTime Time when specimen was received for processing or testing. dateTime
Specimen _receivedTime Extensions for receivedTime Element
Specimen parent Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. Reference
Specimen request Details concerning a service request that required a specimen to be collected. Reference
Specimen collection Details concerning the specimen collection. Specimen_Collection
Specimen processing Details concerning processing and processing steps for the specimen. Specimen_Processing
Specimen container 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
Specimen condition A mode or state of being that describes the nature of the specimen. CodeableConcept
Specimen note To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen). Annotation
SpecimenDefinition resourceType This is a SpecimenDefinition resource SpecimenDefinition
SpecimenDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SpecimenDefinition meta 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. Meta
SpecimenDefinition implicitRules 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. uri
SpecimenDefinition _implicitRules Extensions for implicitRules Element
SpecimenDefinition language The base language in which the resource is written. code
SpecimenDefinition _language Extensions for language Element
SpecimenDefinition text 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. Narrative
SpecimenDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SpecimenDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SpecimenDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SpecimenDefinition identifier A business identifier associated with the kind of specimen. Identifier
SpecimenDefinition typeCollected The kind of material to be collected. CodeableConcept
SpecimenDefinition patientPreparation Preparation of the patient for specimen collection. CodeableConcept
SpecimenDefinition timeAspect Time aspect of specimen collection (duration or offset). string
SpecimenDefinition _timeAspect Extensions for timeAspect Element
SpecimenDefinition collection The action to be performed for collecting the specimen. CodeableConcept
SpecimenDefinition typeTested Specimen conditioned in a container as expected by the testing laboratory. SpecimenDefinition_TypeTested
SpecimenDefinition_Additive id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SpecimenDefinition_Additive extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SpecimenDefinition_Additive modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SpecimenDefinition_Additive additiveCodeableConcept Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. CodeableConcept
SpecimenDefinition_Additive additiveReference Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Reference
SpecimenDefinition_Container id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SpecimenDefinition_Container extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SpecimenDefinition_Container modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SpecimenDefinition_Container material The type of material of the container. CodeableConcept
SpecimenDefinition_Container type The type of container used to contain this kind of specimen. CodeableConcept
SpecimenDefinition_Container cap Color of container cap. CodeableConcept
SpecimenDefinition_Container description The textual description of the kind of container. string
SpecimenDefinition_Container _description Extensions for description Element
SpecimenDefinition_Container capacity The capacity (volume or other measure) of this kind of container. Quantity
SpecimenDefinition_Container minimumVolumeQuantity The minimum volume to be conditioned in the container. Quantity
SpecimenDefinition_Container minimumVolumeString The minimum volume to be conditioned in the container. notDefined
SpecimenDefinition_Container _minimumVolumeString Extensions for minimumVolumeString Element
SpecimenDefinition_Container additive Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. SpecimenDefinition_Additive
SpecimenDefinition_Container preparation Special processing that should be applied to the container for this kind of specimen. string
SpecimenDefinition_Container _preparation Extensions for preparation Element
SpecimenDefinition_Handling id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SpecimenDefinition_Handling extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SpecimenDefinition_Handling modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SpecimenDefinition_Handling temperatureQualifier 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. CodeableConcept
SpecimenDefinition_Handling temperatureRange The temperature interval for this set of handling instructions. Range
SpecimenDefinition_Handling maxDuration The maximum time interval of preservation of the specimen with these conditions. Duration
SpecimenDefinition_Handling instruction Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'. string
SpecimenDefinition_Handling _instruction Extensions for instruction Element
SpecimenDefinition_TypeTested id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SpecimenDefinition_TypeTested extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SpecimenDefinition_TypeTested modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SpecimenDefinition_TypeTested isDerived Primary of secondary specimen. boolean
SpecimenDefinition_TypeTested _isDerived Extensions for isDerived Element
SpecimenDefinition_TypeTested type The kind of specimen conditioned for testing expected by lab. CodeableConcept
SpecimenDefinition_TypeTested preference The preference for this type of conditioned specimen. enum values:
preferred
alternate
SpecimenDefinition_TypeTested _preference Extensions for preference Element
SpecimenDefinition_TypeTested container The specimen's container. SpecimenDefinition_Container
SpecimenDefinition_TypeTested requirement Requirements for delivery and special handling of this kind of conditioned specimen. string
SpecimenDefinition_TypeTested _requirement Extensions for requirement Element
SpecimenDefinition_TypeTested retentionTime The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing. Duration
SpecimenDefinition_TypeTested rejectionCriterion Criterion for rejection of the specimen in its container by the laboratory. CodeableConcept
SpecimenDefinition_TypeTested handling Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process. SpecimenDefinition_Handling
Specimen_Collection id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Specimen_Collection extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Specimen_Collection modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Specimen_Collection collector Person who collected the specimen. Reference
Specimen_Collection collectedDateTime Time when specimen was collected from subject - the physiologically relevant time. notDefined
Specimen_Collection _collectedDateTime Extensions for collectedDateTime Element
Specimen_Collection collectedPeriod Time when specimen was collected from subject - the physiologically relevant time. Period
Specimen_Collection duration The span of time over which the collection of a specimen occurred. Duration
Specimen_Collection quantity The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. Quantity
Specimen_Collection method A coded value specifying the technique that is used to perform the procedure. CodeableConcept
Specimen_Collection bodySite 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. CodeableConcept
Specimen_Collection fastingStatusCodeableConcept Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. CodeableConcept
Specimen_Collection fastingStatusDuration Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. Duration
Specimen_Container id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Specimen_Container extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Specimen_Container modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Specimen_Container identifier Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. Identifier
Specimen_Container description Textual description of the container. string
Specimen_Container _description Extensions for description Element
Specimen_Container type The type of container associated with the specimen (e.g. slide, aliquot, etc.). CodeableConcept
Specimen_Container capacity The capacity (volume or other measure) the container may contain. Quantity
Specimen_Container specimenQuantity The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. Quantity
Specimen_Container additiveCodeableConcept Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. CodeableConcept
Specimen_Container additiveReference Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Reference
Specimen_Processing id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Specimen_Processing extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Specimen_Processing modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Specimen_Processing description Textual description of procedure. string
Specimen_Processing _description Extensions for description Element
Specimen_Processing procedure A coded value specifying the procedure used to process the specimen. CodeableConcept
Specimen_Processing additive Material used in the processing step. Reference
Specimen_Processing timeDateTime 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. notDefined
Specimen_Processing _timeDateTime Extensions for timeDateTime Element
Specimen_Processing timePeriod 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. Period
StructureDefinition resourceType This is a StructureDefinition resource StructureDefinition
StructureDefinition id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
StructureDefinition meta 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. Meta
StructureDefinition implicitRules 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. uri
StructureDefinition _implicitRules Extensions for implicitRules Element
StructureDefinition language The base language in which the resource is written. code
StructureDefinition _language Extensions for language Element
StructureDefinition text 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. Narrative
StructureDefinition contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
StructureDefinition extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureDefinition modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureDefinition url 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 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. uri
StructureDefinition _url Extensions for url Element
StructureDefinition identifier 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. Identifier
StructureDefinition version 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. 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. string
StructureDefinition _version Extensions for version Element
StructureDefinition name 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. string
StructureDefinition _name Extensions for name Element
StructureDefinition title A short, descriptive, user-friendly title for the structure definition. string
StructureDefinition _title Extensions for title Element
StructureDefinition status The status of this structure definition. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
StructureDefinition _status Extensions for status Element
StructureDefinition experimental 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. boolean
StructureDefinition _experimental Extensions for experimental Element
StructureDefinition date The date (and optionally time) when the structure definition 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 structure definition changes. dateTime
StructureDefinition _date Extensions for date Element
StructureDefinition publisher The name of the organization or individual that published the structure definition. string
StructureDefinition _publisher Extensions for publisher Element
StructureDefinition contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
StructureDefinition description A free text natural language description of the structure definition from a consumer's perspective. markdown
StructureDefinition _description Extensions for description Element
StructureDefinition useContext 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. UsageContext
StructureDefinition jurisdiction A legal or geographic region in which the structure definition is intended to be used. CodeableConcept
StructureDefinition purpose Explanation of why this structure definition is needed and why it has been designed as it has. markdown
StructureDefinition _purpose Extensions for purpose Element
StructureDefinition copyright 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. markdown
StructureDefinition _copyright Extensions for copyright Element
StructureDefinition keyword 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. Coding
StructureDefinition fhirVersion 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.0.0. for this version. enum values:
0.01
0.05
0.06
0.11
0.0.80
0.0.81
0.0.82
0.4.0
0.5.0
1.0.0
1.0.1
1.0.2
1.1.0
1.4.0
1.6.0
1.8.0
3.0.0
3.0.1
3.3.0
3.5.0
4.0.0
StructureDefinition _fhirVersion Extensions for fhirVersion Element
StructureDefinition mapping An external specification that the content is mapped to. StructureDefinition_Mapping
StructureDefinition kind Defines the kind of structure that this definition is describing. enum values:
primitive-type
complex-type
resource
logical
StructureDefinition _kind Extensions for kind Element
StructureDefinition abstract 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. boolean
StructureDefinition _abstract Extensions for abstract Element
StructureDefinition context Identifies the types of resource or data type elements to which the extension can be applied. StructureDefinition_Context
StructureDefinition contextInvariant 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. string
StructureDefinition _contextInvariant Extensions for contextInvariant Element
StructureDefinition type 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. uri
StructureDefinition _type Extensions for type Element
StructureDefinition baseDefinition An absolute URI that is the base structure from which this type is derived, either by specialization or constraint. canonical
StructureDefinition derivation How the type relates to the baseDefinition. enum values:
specialization
constraint
StructureDefinition _derivation Extensions for derivation Element
StructureDefinition snapshot A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition. StructureDefinition_Snapshot
StructureDefinition differential A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies. StructureDefinition_Differential
StructureDefinition_Context id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureDefinition_Context extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureDefinition_Context modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureDefinition_Context type Defines how to interpret the expression that defines what the context of the extension is. enum values:
fhirpath
element
extension
StructureDefinition_Context _type Extensions for type Element
StructureDefinition_Context expression An expression that defines where an extension can be used in resources. string
StructureDefinition_Context _expression Extensions for expression Element
StructureDefinition_Differential id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureDefinition_Differential extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureDefinition_Differential modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureDefinition_Differential element Captures constraints on each element within the resource. ElementDefinition
StructureDefinition_Mapping id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureDefinition_Mapping extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureDefinition_Mapping modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureDefinition_Mapping identity An Internal id that is used to identify this mapping set when specific mappings are made. id
StructureDefinition_Mapping _identity Extensions for identity Element
StructureDefinition_Mapping uri An absolute URI that identifies the specification that this mapping is expressed to. uri
StructureDefinition_Mapping _uri Extensions for uri Element
StructureDefinition_Mapping name A name for the specification that is being mapped to. string
StructureDefinition_Mapping _name Extensions for name Element
StructureDefinition_Mapping comment Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. string
StructureDefinition_Mapping _comment Extensions for comment Element
StructureDefinition_Snapshot id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureDefinition_Snapshot extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureDefinition_Snapshot modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureDefinition_Snapshot element Captures constraints on each element within the resource. ElementDefinition
StructureMap resourceType This is a StructureMap resource StructureMap
StructureMap id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
StructureMap meta 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. Meta
StructureMap implicitRules 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. uri
StructureMap _implicitRules Extensions for implicitRules Element
StructureMap language The base language in which the resource is written. code
StructureMap _language Extensions for language Element
StructureMap text 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. Narrative
StructureMap contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
StructureMap extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap url 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 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. uri
StructureMap _url Extensions for url Element
StructureMap identifier 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. Identifier
StructureMap version 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. string
StructureMap _version Extensions for version Element
StructureMap name 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. string
StructureMap _name Extensions for name Element
StructureMap title A short, descriptive, user-friendly title for the structure map. string
StructureMap _title Extensions for title Element
StructureMap status The status of this structure map. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
StructureMap _status Extensions for status Element
StructureMap experimental 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. boolean
StructureMap _experimental Extensions for experimental Element
StructureMap date The date (and optionally time) when the structure map 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 structure map changes. dateTime
StructureMap _date Extensions for date Element
StructureMap publisher The name of the organization or individual that published the structure map. string
StructureMap _publisher Extensions for publisher Element
StructureMap contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
StructureMap description A free text natural language description of the structure map from a consumer's perspective. markdown
StructureMap _description Extensions for description Element
StructureMap useContext 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. UsageContext
StructureMap jurisdiction A legal or geographic region in which the structure map is intended to be used. CodeableConcept
StructureMap purpose Explanation of why this structure map is needed and why it has been designed as it has. markdown
StructureMap _purpose Extensions for purpose Element
StructureMap copyright 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. markdown
StructureMap _copyright Extensions for copyright Element
StructureMap structure A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced. StructureMap_Structure
StructureMap import Other maps used by this map (canonical URLs). canonical
StructureMap group Organizes the mapping into manageable chunks for human review/ease of maintenance. StructureMap_Group
StructureMap_Dependent id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Dependent extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Dependent modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Dependent name Name of a rule or group to apply. id
StructureMap_Dependent _name Extensions for name Element
StructureMap_Dependent variable Variable to pass to the rule or group. string
StructureMap_Dependent _variable Extensions for variable Element
StructureMap_Group id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Group extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Group modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Group name A unique name for the group for the convenience of human readers. id
StructureMap_Group _name Extensions for name Element
StructureMap_Group extends Another group that this group adds rules to. id
StructureMap_Group _extends Extensions for extends Element
StructureMap_Group typeMode If this is the default rule set to apply for the source type or this combination of types. enum values:
none
types
type-and-types
StructureMap_Group _typeMode Extensions for typeMode Element
StructureMap_Group documentation Additional supporting documentation that explains the purpose of the group and the types of mappings within it. string
StructureMap_Group _documentation Extensions for documentation Element
StructureMap_Group input A name assigned to an instance of data. The instance must be provided when the mapping is invoked. StructureMap_Input
StructureMap_Group rule Transform Rule from source to target. StructureMap_Rule
StructureMap_Input id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Input extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Input modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Input name Name for this instance of data. id
StructureMap_Input _name Extensions for name Element
StructureMap_Input type Type for this instance of data. string
StructureMap_Input _type Extensions for type Element
StructureMap_Input mode Mode for this instance of data. enum values:
source
target
StructureMap_Input _mode Extensions for mode Element
StructureMap_Input documentation Documentation for this instance of data. string
StructureMap_Input _documentation Extensions for documentation Element
StructureMap_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Parameter valueId Parameter value - variable or literal. notDefined
StructureMap_Parameter _valueId Extensions for valueId Element
StructureMap_Parameter valueString Parameter value - variable or literal. notDefined
StructureMap_Parameter _valueString Extensions for valueString Element
StructureMap_Parameter valueBoolean Parameter value - variable or literal. notDefined
StructureMap_Parameter _valueBoolean Extensions for valueBoolean Element
StructureMap_Parameter valueInteger Parameter value - variable or literal. notDefined
StructureMap_Parameter _valueInteger Extensions for valueInteger Element
StructureMap_Parameter valueDecimal Parameter value - variable or literal. notDefined
StructureMap_Parameter _valueDecimal Extensions for valueDecimal Element
StructureMap_Rule id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Rule extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Rule modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Rule name Name of the rule for internal references. id
StructureMap_Rule _name Extensions for name Element
StructureMap_Rule source Source inputs to the mapping. StructureMap_Source
StructureMap_Rule target Content to create because of this mapping rule. StructureMap_Target
StructureMap_Rule rule Rules contained in this rule. StructureMap_Rule
StructureMap_Rule dependent Which other rules to apply in the context of this rule. StructureMap_Dependent
StructureMap_Rule documentation Documentation for this instance of data. string
StructureMap_Rule _documentation Extensions for documentation Element
StructureMap_Source id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Source extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Source modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Source context Type or variable this rule applies to. id
StructureMap_Source _context Extensions for context Element
StructureMap_Source min Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content. integer
StructureMap_Source _min Extensions for min Element
StructureMap_Source max 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). string
StructureMap_Source _max Extensions for max Element
StructureMap_Source type Specified type for the element. This works as a condition on the mapping - use for polymorphic elements. string
StructureMap_Source _type Extensions for type Element
StructureMap_Source defaultValueBase64Binary A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueBase64Binary Extensions for defaultValueBase64Binary Element
StructureMap_Source defaultValueBoolean A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueBoolean Extensions for defaultValueBoolean Element
StructureMap_Source defaultValueCanonical A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueCanonical Extensions for defaultValueCanonical Element
StructureMap_Source defaultValueCode A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueCode Extensions for defaultValueCode Element
StructureMap_Source defaultValueDate A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueDate Extensions for defaultValueDate Element
StructureMap_Source defaultValueDateTime A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueDateTime Extensions for defaultValueDateTime Element
StructureMap_Source defaultValueDecimal A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueDecimal Extensions for defaultValueDecimal Element
StructureMap_Source defaultValueId A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueId Extensions for defaultValueId Element
StructureMap_Source defaultValueInstant A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueInstant Extensions for defaultValueInstant Element
StructureMap_Source defaultValueInteger A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueInteger Extensions for defaultValueInteger Element
StructureMap_Source defaultValueMarkdown A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueMarkdown Extensions for defaultValueMarkdown Element
StructureMap_Source defaultValueOid A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueOid Extensions for defaultValueOid Element
StructureMap_Source defaultValuePositiveInt A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValuePositiveInt Extensions for defaultValuePositiveInt Element
StructureMap_Source defaultValueString A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueString Extensions for defaultValueString Element
StructureMap_Source defaultValueTime A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueTime Extensions for defaultValueTime Element
StructureMap_Source defaultValueUnsignedInt A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueUnsignedInt Extensions for defaultValueUnsignedInt Element
StructureMap_Source defaultValueUri A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueUri Extensions for defaultValueUri Element
StructureMap_Source defaultValueUrl A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueUrl Extensions for defaultValueUrl Element
StructureMap_Source defaultValueUuid A value to use if there is no existing value in the source object. notDefined
StructureMap_Source _defaultValueUuid Extensions for defaultValueUuid Element
StructureMap_Source defaultValueAddress A value to use if there is no existing value in the source object. Address
StructureMap_Source defaultValueAge A value to use if there is no existing value in the source object. Age
StructureMap_Source defaultValueAnnotation A value to use if there is no existing value in the source object. Annotation
StructureMap_Source defaultValueAttachment A value to use if there is no existing value in the source object. Attachment
StructureMap_Source defaultValueCodeableConcept A value to use if there is no existing value in the source object. CodeableConcept
StructureMap_Source defaultValueCoding A value to use if there is no existing value in the source object. Coding
StructureMap_Source defaultValueContactPoint A value to use if there is no existing value in the source object. ContactPoint
StructureMap_Source defaultValueCount A value to use if there is no existing value in the source object. Count
StructureMap_Source defaultValueDistance A value to use if there is no existing value in the source object. Distance
StructureMap_Source defaultValueDuration A value to use if there is no existing value in the source object. Duration
StructureMap_Source defaultValueHumanName A value to use if there is no existing value in the source object. HumanName
StructureMap_Source defaultValueIdentifier A value to use if there is no existing value in the source object. Identifier
StructureMap_Source defaultValueMoney A value to use if there is no existing value in the source object. Money
StructureMap_Source defaultValuePeriod A value to use if there is no existing value in the source object. Period
StructureMap_Source defaultValueQuantity A value to use if there is no existing value in the source object. Quantity
StructureMap_Source defaultValueRange A value to use if there is no existing value in the source object. Range
StructureMap_Source defaultValueRatio A value to use if there is no existing value in the source object. Ratio
StructureMap_Source defaultValueReference A value to use if there is no existing value in the source object. Reference
StructureMap_Source defaultValueSampledData A value to use if there is no existing value in the source object. SampledData
StructureMap_Source defaultValueSignature A value to use if there is no existing value in the source object. Signature
StructureMap_Source defaultValueTiming A value to use if there is no existing value in the source object. Timing
StructureMap_Source defaultValueContactDetail A value to use if there is no existing value in the source object. ContactDetail
StructureMap_Source defaultValueContributor A value to use if there is no existing value in the source object. Contributor
StructureMap_Source defaultValueDataRequirement A value to use if there is no existing value in the source object. DataRequirement
StructureMap_Source defaultValueExpression A value to use if there is no existing value in the source object. Expression
StructureMap_Source defaultValueParameterDefinition A value to use if there is no existing value in the source object. ParameterDefinition
StructureMap_Source defaultValueRelatedArtifact A value to use if there is no existing value in the source object. RelatedArtifact
StructureMap_Source defaultValueTriggerDefinition A value to use if there is no existing value in the source object. TriggerDefinition
StructureMap_Source defaultValueUsageContext A value to use if there is no existing value in the source object. UsageContext
StructureMap_Source defaultValueDosage A value to use if there is no existing value in the source object. Dosage
StructureMap_Source element Optional field for this source. string
StructureMap_Source _element Extensions for element Element
StructureMap_Source listMode How to handle the list mode for this element. enum values:
first
not_first
last
not_last
only_one
StructureMap_Source _listMode Extensions for listMode Element
StructureMap_Source variable Named context for field, if a field is specified. id
StructureMap_Source _variable Extensions for variable Element
StructureMap_Source condition FHIRPath expression - must be true or the rule does not apply. string
StructureMap_Source _condition Extensions for condition Element
StructureMap_Source check FHIRPath expression - must be true or the mapping engine throws an error instead of completing. string
StructureMap_Source _check Extensions for check Element
StructureMap_Source logMessage A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found. string
StructureMap_Source _logMessage Extensions for logMessage Element
StructureMap_Structure id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Structure extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Structure modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Structure url The canonical reference to the structure. canonical
StructureMap_Structure mode How the referenced structure is used in this mapping. enum values:
source
queried
target
produced
StructureMap_Structure _mode Extensions for mode Element
StructureMap_Structure alias The name used for this type in the map. string
StructureMap_Structure _alias Extensions for alias Element
StructureMap_Structure documentation Documentation that describes how the structure is used in the mapping. string
StructureMap_Structure _documentation Extensions for documentation Element
StructureMap_Target id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
StructureMap_Target extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
StructureMap_Target modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
StructureMap_Target context Type or variable this rule applies to. id
StructureMap_Target _context Extensions for context Element
StructureMap_Target contextType How to interpret the context. enum values:
type
variable
StructureMap_Target _contextType Extensions for contextType Element
StructureMap_Target element Field to create in the context. string
StructureMap_Target _element Extensions for element Element
StructureMap_Target variable Named context for field, if desired, and a field is specified. id
StructureMap_Target _variable Extensions for variable Element
StructureMap_Target listMode If field is a list, how to manage the list. enum values:
first
share
last
collate
StructureMap_Target _listMode Extensions for listMode Element
StructureMap_Target listRuleId Internal rule reference for shared list items. id
StructureMap_Target _listRuleId Extensions for listRuleId Element
StructureMap_Target transform How the data is copied / created. enum values:
create
copy
truncate
escape
cast
append
translate
reference
dateOp
uuid
pointer
evaluate
cc
c
qty
id
cp
StructureMap_Target _transform Extensions for transform Element
StructureMap_Target parameter Parameters to the transform. StructureMap_Parameter
Subscription resourceType This is a Subscription resource Subscription
Subscription id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Subscription meta 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. Meta
Subscription implicitRules 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. uri
Subscription _implicitRules Extensions for implicitRules Element
Subscription language The base language in which the resource is written. code
Subscription _language Extensions for language Element
Subscription text 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. Narrative
Subscription contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Subscription extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Subscription modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Subscription status The status of the subscription, which marks the server state for managing the subscription. enum values:
requested
active
error
off
Subscription _status Extensions for status Element
Subscription contact Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. ContactPoint
Subscription end The time for the server to turn the subscription off. instant
Subscription _end Extensions for end Element
Subscription reason A description of why this subscription is defined. string
Subscription _reason Extensions for reason Element
Subscription criteria The rules that the server should use to determine when to generate notifications for this subscription. string
Subscription _criteria Extensions for criteria Element
Subscription error A record of the last error that occurred when the server processed a notification. string
Subscription _error Extensions for error Element
Subscription channel Details where to send notifications when resources are received that meet the criteria. Subscription_Channel
Subscription_Channel id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Subscription_Channel extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Subscription_Channel modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Subscription_Channel type The type of channel to send notifications on. enum values:
rest-hook
websocket
email
sms
message
Subscription_Channel _type Extensions for type Element
Subscription_Channel endpoint The url that describes the actual end-point to send messages to. url
Subscription_Channel _endpoint Extensions for endpoint Element
Subscription_Channel payload The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions. code
Subscription_Channel _payload Extensions for payload Element
Subscription_Channel header Additional headers / information to send as part of the notification. string
Subscription_Channel _header Extensions for header Element
Substance resourceType This is a Substance resource Substance
Substance id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Substance meta 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. Meta
Substance implicitRules 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. uri
Substance _implicitRules Extensions for implicitRules Element
Substance language The base language in which the resource is written. code
Substance _language Extensions for language Element
Substance text 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. Narrative
Substance contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Substance extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Substance modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Substance identifier Unique identifier for the substance. Identifier
Substance status A code to indicate if the substance is actively used. enum values:
active
inactive
entered-in-error
Substance _status Extensions for status Element
Substance category A code that classifies the general type of substance. This is used for searching, sorting and display purposes. CodeableConcept
Substance code A code (or set of codes) that identify this substance. CodeableConcept
Substance description A description of the substance - its appearance, handling requirements, and other usage notes. string
Substance _description Extensions for description Element
Substance instance Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance. Substance_Instance
Substance ingredient A substance can be composed of other substances. Substance_Ingredient
SubstanceAmount id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceAmount extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceAmount modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceAmount amountQuantity 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. Quantity
SubstanceAmount amountRange 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. Range
SubstanceAmount amountString 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. notDefined
SubstanceAmount _amountString Extensions for amountString Element
SubstanceAmount amountType Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements. CodeableConcept
SubstanceAmount amountText A textual comment on a numeric value. string
SubstanceAmount _amountText Extensions for amountText Element
SubstanceAmount referenceRange Reference range of possible or expected values. SubstanceAmount_ReferenceRange
SubstanceAmount_ReferenceRange id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceAmount_ReferenceRange extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceAmount_ReferenceRange modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceAmount_ReferenceRange lowLimit Lower limit possible or expected. Quantity
SubstanceAmount_ReferenceRange highLimit Upper limit possible or expected. Quantity
SubstanceNucleicAcid resourceType This is a SubstanceNucleicAcid resource SubstanceNucleicAcid
SubstanceNucleicAcid id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SubstanceNucleicAcid meta 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. Meta
SubstanceNucleicAcid implicitRules 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. uri
SubstanceNucleicAcid _implicitRules Extensions for implicitRules Element
SubstanceNucleicAcid language The base language in which the resource is written. code
SubstanceNucleicAcid _language Extensions for language Element
SubstanceNucleicAcid text 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. Narrative
SubstanceNucleicAcid contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SubstanceNucleicAcid extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceNucleicAcid modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceNucleicAcid sequenceType The type of the sequence shall be specified based on a controlled vocabulary. CodeableConcept
SubstanceNucleicAcid numberOfSubunits 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. integer
SubstanceNucleicAcid _numberOfSubunits Extensions for numberOfSubunits Element
SubstanceNucleicAcid areaOfHybridisation 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”. string
SubstanceNucleicAcid _areaOfHybridisation Extensions for areaOfHybridisation Element
SubstanceNucleicAcid oligoNucleotideType (TBC). CodeableConcept
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
SubstanceNucleicAcid_Linkage id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceNucleicAcid_Linkage extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceNucleicAcid_Linkage modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceNucleicAcid_Linkage connectivity 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. string
SubstanceNucleicAcid_Linkage _connectivity Extensions for connectivity Element
SubstanceNucleicAcid_Linkage identifier Each linkage will be registered as a fragment and have an ID. Identifier
SubstanceNucleicAcid_Linkage name Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage. string
SubstanceNucleicAcid_Linkage _name Extensions for name Element
SubstanceNucleicAcid_Linkage residueSite Residues shall be captured as described in 5.3.6.8.3. string
SubstanceNucleicAcid_Linkage _residueSite Extensions for residueSite Element
SubstanceNucleicAcid_Subunit id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceNucleicAcid_Subunit extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceNucleicAcid_Subunit modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceNucleicAcid_Subunit subunit 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. integer
SubstanceNucleicAcid_Subunit _subunit Extensions for subunit Element
SubstanceNucleicAcid_Subunit sequence 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. string
SubstanceNucleicAcid_Subunit _sequence Extensions for sequence Element
SubstanceNucleicAcid_Subunit length The length of the sequence shall be captured. integer
SubstanceNucleicAcid_Subunit _length Extensions for length Element
SubstanceNucleicAcid_Subunit sequenceAttachment (TBC). Attachment
SubstanceNucleicAcid_Subunit fivePrime 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. CodeableConcept
SubstanceNucleicAcid_Subunit threePrime 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. CodeableConcept
SubstanceNucleicAcid_Subunit linkage The linkages between sugar residues will also be captured. SubstanceNucleicAcid_Linkage
SubstanceNucleicAcid_Subunit sugar 5.3.6.8.1 Sugar ID (Mandatory). SubstanceNucleicAcid_Sugar
SubstanceNucleicAcid_Sugar id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceNucleicAcid_Sugar extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceNucleicAcid_Sugar modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceNucleicAcid_Sugar identifier The Substance ID of the sugar or sugar-like component that make up the nucleotide. Identifier
SubstanceNucleicAcid_Sugar name The name of the sugar or sugar-like component that make up the nucleotide. string
SubstanceNucleicAcid_Sugar _name Extensions for name Element
SubstanceNucleicAcid_Sugar residueSite 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. string
SubstanceNucleicAcid_Sugar _residueSite Extensions for residueSite Element
SubstancePolymer resourceType This is a SubstancePolymer resource SubstancePolymer
SubstancePolymer id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SubstancePolymer meta 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. Meta
SubstancePolymer implicitRules 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. uri
SubstancePolymer _implicitRules Extensions for implicitRules Element
SubstancePolymer language The base language in which the resource is written. code
SubstancePolymer _language Extensions for language Element
SubstancePolymer text 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. Narrative
SubstancePolymer contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SubstancePolymer extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstancePolymer modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstancePolymer class Todo. CodeableConcept
SubstancePolymer geometry Todo. CodeableConcept
SubstancePolymer copolymerConnectivity Todo. CodeableConcept
SubstancePolymer modification Todo. string
SubstancePolymer _modification Extensions for modification Element
SubstancePolymer monomerSet Todo. SubstancePolymer_MonomerSet
SubstancePolymer repeat Todo. SubstancePolymer_Repeat
SubstancePolymer_DegreeOfPolymerisation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstancePolymer_DegreeOfPolymerisation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstancePolymer_DegreeOfPolymerisation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstancePolymer_DegreeOfPolymerisation degree Todo. CodeableConcept
SubstancePolymer_DegreeOfPolymerisation amount Todo. SubstanceAmount
SubstancePolymer_MonomerSet id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstancePolymer_MonomerSet extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstancePolymer_MonomerSet modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstancePolymer_MonomerSet ratioType Todo. CodeableConcept
SubstancePolymer_MonomerSet startingMaterial Todo. SubstancePolymer_StartingMaterial
SubstancePolymer_Repeat id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstancePolymer_Repeat extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstancePolymer_Repeat modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstancePolymer_Repeat numberOfUnits Todo. integer
SubstancePolymer_Repeat _numberOfUnits Extensions for numberOfUnits Element
SubstancePolymer_Repeat averageMolecularFormula Todo. string
SubstancePolymer_Repeat _averageMolecularFormula Extensions for averageMolecularFormula Element
SubstancePolymer_Repeat repeatUnitAmountType Todo. CodeableConcept
SubstancePolymer_Repeat repeatUnit Todo. SubstancePolymer_RepeatUnit
SubstancePolymer_RepeatUnit id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstancePolymer_RepeatUnit extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstancePolymer_RepeatUnit modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstancePolymer_RepeatUnit orientationOfPolymerisation Todo. CodeableConcept
SubstancePolymer_RepeatUnit repeatUnit Todo. string
SubstancePolymer_RepeatUnit _repeatUnit Extensions for repeatUnit Element
SubstancePolymer_RepeatUnit amount Todo. SubstanceAmount
SubstancePolymer_RepeatUnit degreeOfPolymerisation Todo. SubstancePolymer_DegreeOfPolymerisation
SubstancePolymer_RepeatUnit structuralRepresentation Todo. SubstancePolymer_StructuralRepresentation
SubstancePolymer_StartingMaterial id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstancePolymer_StartingMaterial extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstancePolymer_StartingMaterial modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstancePolymer_StartingMaterial material Todo. CodeableConcept
SubstancePolymer_StartingMaterial type Todo. CodeableConcept
SubstancePolymer_StartingMaterial isDefining Todo. boolean
SubstancePolymer_StartingMaterial _isDefining Extensions for isDefining Element
SubstancePolymer_StartingMaterial amount Todo. SubstanceAmount
SubstancePolymer_StructuralRepresentation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstancePolymer_StructuralRepresentation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstancePolymer_StructuralRepresentation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstancePolymer_StructuralRepresentation type Todo. CodeableConcept
SubstancePolymer_StructuralRepresentation representation Todo. string
SubstancePolymer_StructuralRepresentation _representation Extensions for representation Element
SubstancePolymer_StructuralRepresentation attachment Todo. Attachment
SubstanceProtein resourceType This is a SubstanceProtein resource SubstanceProtein
SubstanceProtein id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SubstanceProtein meta 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. Meta
SubstanceProtein implicitRules 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. uri
SubstanceProtein _implicitRules Extensions for implicitRules Element
SubstanceProtein language The base language in which the resource is written. code
SubstanceProtein _language Extensions for language Element
SubstanceProtein text 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. Narrative
SubstanceProtein contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SubstanceProtein extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceProtein modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceProtein sequenceType 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. CodeableConcept
SubstanceProtein numberOfSubunits 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. integer
SubstanceProtein _numberOfSubunits Extensions for numberOfSubunits Element
SubstanceProtein disulfideLinkage 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. string
SubstanceProtein _disulfideLinkage Extensions for disulfideLinkage Element
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
SubstanceProtein_Subunit id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceProtein_Subunit extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceProtein_Subunit modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceProtein_Subunit subunit 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. integer
SubstanceProtein_Subunit _subunit Extensions for subunit Element
SubstanceProtein_Subunit sequence 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. string
SubstanceProtein_Subunit _sequence Extensions for sequence Element
SubstanceProtein_Subunit length Length of linear sequences of amino acids contained in the subunit. integer
SubstanceProtein_Subunit _length Extensions for length Element
SubstanceProtein_Subunit sequenceAttachment 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. Attachment
SubstanceProtein_Subunit nTerminalModificationId Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID. Identifier
SubstanceProtein_Subunit nTerminalModification The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified. string
SubstanceProtein_Subunit _nTerminalModification Extensions for nTerminalModification Element
SubstanceProtein_Subunit cTerminalModificationId Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID. Identifier
SubstanceProtein_Subunit cTerminalModification The modification at the C-terminal shall be specified. string
SubstanceProtein_Subunit _cTerminalModification Extensions for cTerminalModification Element
SubstanceReferenceInformation resourceType This is a SubstanceReferenceInformation resource SubstanceReferenceInformation
SubstanceReferenceInformation id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SubstanceReferenceInformation meta 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. Meta
SubstanceReferenceInformation implicitRules 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. uri
SubstanceReferenceInformation _implicitRules Extensions for implicitRules Element
SubstanceReferenceInformation language The base language in which the resource is written. code
SubstanceReferenceInformation _language Extensions for language Element
SubstanceReferenceInformation text 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. Narrative
SubstanceReferenceInformation contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SubstanceReferenceInformation extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceReferenceInformation modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceReferenceInformation comment Todo. string
SubstanceReferenceInformation _comment Extensions for comment Element
SubstanceReferenceInformation gene Todo. SubstanceReferenceInformation_Gene
SubstanceReferenceInformation geneElement Todo. SubstanceReferenceInformation_GeneElement
SubstanceReferenceInformation classification Todo. SubstanceReferenceInformation_Classification
SubstanceReferenceInformation target Todo. SubstanceReferenceInformation_Target
SubstanceReferenceInformation_Classification id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceReferenceInformation_Classification extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceReferenceInformation_Classification modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceReferenceInformation_Classification domain Todo. CodeableConcept
SubstanceReferenceInformation_Classification classification Todo. CodeableConcept
SubstanceReferenceInformation_Classification subtype Todo. CodeableConcept
SubstanceReferenceInformation_Classification source Todo. Reference
SubstanceReferenceInformation_Gene id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceReferenceInformation_Gene extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceReferenceInformation_Gene modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceReferenceInformation_Gene geneSequenceOrigin Todo. CodeableConcept
SubstanceReferenceInformation_Gene gene Todo. CodeableConcept
SubstanceReferenceInformation_Gene source Todo. Reference
SubstanceReferenceInformation_GeneElement id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceReferenceInformation_GeneElement extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceReferenceInformation_GeneElement modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceReferenceInformation_GeneElement type Todo. CodeableConcept
SubstanceReferenceInformation_GeneElement element Todo. Identifier
SubstanceReferenceInformation_GeneElement source Todo. Reference
SubstanceReferenceInformation_Target id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceReferenceInformation_Target extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceReferenceInformation_Target modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceReferenceInformation_Target target Todo. Identifier
SubstanceReferenceInformation_Target type Todo. CodeableConcept
SubstanceReferenceInformation_Target interaction Todo. CodeableConcept
SubstanceReferenceInformation_Target organism Todo. CodeableConcept
SubstanceReferenceInformation_Target organismType Todo. CodeableConcept
SubstanceReferenceInformation_Target amountQuantity Todo. Quantity
SubstanceReferenceInformation_Target amountRange Todo. Range
SubstanceReferenceInformation_Target amountString Todo. notDefined
SubstanceReferenceInformation_Target _amountString Extensions for amountString Element
SubstanceReferenceInformation_Target amountType Todo. CodeableConcept
SubstanceReferenceInformation_Target source Todo. Reference
SubstanceSourceMaterial resourceType This is a SubstanceSourceMaterial resource SubstanceSourceMaterial
SubstanceSourceMaterial id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SubstanceSourceMaterial meta 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. Meta
SubstanceSourceMaterial implicitRules 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. uri
SubstanceSourceMaterial _implicitRules Extensions for implicitRules Element
SubstanceSourceMaterial language The base language in which the resource is written. code
SubstanceSourceMaterial _language Extensions for language Element
SubstanceSourceMaterial text 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. Narrative
SubstanceSourceMaterial contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SubstanceSourceMaterial extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSourceMaterial modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSourceMaterial sourceMaterialClass General high level classification of the source material specific to the origin of the material. CodeableConcept
SubstanceSourceMaterial sourceMaterialType 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. CodeableConcept
SubstanceSourceMaterial sourceMaterialState The state of the source material when extracted. CodeableConcept
SubstanceSourceMaterial organismId The unique identifier associated with the source material parent organism shall be specified. Identifier
SubstanceSourceMaterial organismName The organism accepted Scientific name shall be provided based on the organism taxonomy. string
SubstanceSourceMaterial _organismName Extensions for organismName Element
SubstanceSourceMaterial parentSubstanceId 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). Identifier
SubstanceSourceMaterial parentSubstanceName The parent substance of the Herbal Drug, or Herbal preparation. string
SubstanceSourceMaterial _parentSubstanceName Extensions for parentSubstanceName Element
SubstanceSourceMaterial countryOfOrigin 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. CodeableConcept
SubstanceSourceMaterial geographicalLocation The place/region where the plant is harvested or the places/regions where the animal source material has its habitat. string
SubstanceSourceMaterial _geographicalLocation Extensions for geographicalLocation Element
SubstanceSourceMaterial developmentStage 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). CodeableConcept
SubstanceSourceMaterial fractionDescription 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
SubstanceSourceMaterial organism 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
SubstanceSourceMaterial partDescription To do. SubstanceSourceMaterial_PartDescription
SubstanceSourceMaterial_Author id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSourceMaterial_Author extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSourceMaterial_Author modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSourceMaterial_Author authorType 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. CodeableConcept
SubstanceSourceMaterial_Author authorDescription 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). string
SubstanceSourceMaterial_Author _authorDescription Extensions for authorDescription Element
SubstanceSourceMaterial_FractionDescription id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSourceMaterial_FractionDescription extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSourceMaterial_FractionDescription modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSourceMaterial_FractionDescription fraction This element is capturing information about the fraction of a plant part, or human plasma for fractionation. string
SubstanceSourceMaterial_FractionDescription _fraction Extensions for fraction Element
SubstanceSourceMaterial_FractionDescription materialType 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. CodeableConcept
SubstanceSourceMaterial_Hybrid id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSourceMaterial_Hybrid extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSourceMaterial_Hybrid modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSourceMaterial_Hybrid maternalOrganismId 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. string
SubstanceSourceMaterial_Hybrid _maternalOrganismId Extensions for maternalOrganismId Element
SubstanceSourceMaterial_Hybrid maternalOrganismName 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. string
SubstanceSourceMaterial_Hybrid _maternalOrganismName Extensions for maternalOrganismName Element
SubstanceSourceMaterial_Hybrid paternalOrganismId The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. string
SubstanceSourceMaterial_Hybrid _paternalOrganismId Extensions for paternalOrganismId Element
SubstanceSourceMaterial_Hybrid paternalOrganismName The name of the paternal species constituting the hybrid organism shall be specified. string
SubstanceSourceMaterial_Hybrid _paternalOrganismName Extensions for paternalOrganismName Element
SubstanceSourceMaterial_Hybrid hybridType The hybrid type of an organism shall be specified. CodeableConcept
SubstanceSourceMaterial_Organism id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSourceMaterial_Organism extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSourceMaterial_Organism modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSourceMaterial_Organism family The family of an organism shall be specified. CodeableConcept
SubstanceSourceMaterial_Organism genus 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. CodeableConcept
SubstanceSourceMaterial_Organism species 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. CodeableConcept
SubstanceSourceMaterial_Organism intraspecificType The Intraspecific type of an organism shall be specified. CodeableConcept
SubstanceSourceMaterial_Organism intraspecificDescription 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. string
SubstanceSourceMaterial_Organism _intraspecificDescription Extensions for intraspecificDescription Element
SubstanceSourceMaterial_Organism author 4.9.13.6.1 Author type (Conditional). SubstanceSourceMaterial_Author
SubstanceSourceMaterial_Organism hybrid 4.9.13.8.1 Hybrid species maternal organism ID (Optional). SubstanceSourceMaterial_Hybrid
SubstanceSourceMaterial_Organism organismGeneral 4.9.13.7.1 Kingdom (Conditional). SubstanceSourceMaterial_OrganismGeneral
SubstanceSourceMaterial_OrganismGeneral id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSourceMaterial_OrganismGeneral extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSourceMaterial_OrganismGeneral modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSourceMaterial_OrganismGeneral kingdom The kingdom of an organism shall be specified. CodeableConcept
SubstanceSourceMaterial_OrganismGeneral phylum The phylum of an organism shall be specified. CodeableConcept
SubstanceSourceMaterial_OrganismGeneral class The class of an organism shall be specified. CodeableConcept
SubstanceSourceMaterial_OrganismGeneral order The order of an organism shall be specified,. CodeableConcept
SubstanceSourceMaterial_PartDescription id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSourceMaterial_PartDescription extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSourceMaterial_PartDescription modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSourceMaterial_PartDescription part Entity of anatomical origin of source material within an organism. CodeableConcept
SubstanceSourceMaterial_PartDescription partLocation The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply. CodeableConcept
SubstanceSpecification resourceType This is a SubstanceSpecification resource SubstanceSpecification
SubstanceSpecification id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SubstanceSpecification meta 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. Meta
SubstanceSpecification implicitRules 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. uri
SubstanceSpecification _implicitRules Extensions for implicitRules Element
SubstanceSpecification language The base language in which the resource is written. code
SubstanceSpecification _language Extensions for language Element
SubstanceSpecification text 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. Narrative
SubstanceSpecification contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SubstanceSpecification extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification identifier Identifier by which this substance is known. Identifier
SubstanceSpecification type High level categorization, e.g. polymer or nucleic acid. CodeableConcept
SubstanceSpecification status Status of substance within the catalogue e.g. approved. CodeableConcept
SubstanceSpecification domain If the substance applies to only human or veterinary use. CodeableConcept
SubstanceSpecification description Textual description of the substance. string
SubstanceSpecification _description Extensions for description Element
SubstanceSpecification source Supporting literature. Reference
SubstanceSpecification comment Textual comment about this record of a substance. string
SubstanceSpecification _comment Extensions for comment Element
SubstanceSpecification moiety Moiety, for structural modifications. SubstanceSpecification_Moiety
SubstanceSpecification property General specifications for this substance, including how it is related to other substances. SubstanceSpecification_Property
SubstanceSpecification referenceInformation General information detailing this substance. Reference
SubstanceSpecification structure Structural information. SubstanceSpecification_Structure
SubstanceSpecification code Codes associated with the substance. SubstanceSpecification_Code
SubstanceSpecification name Names applicable to this substance. SubstanceSpecification_Name
SubstanceSpecification molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids). SubstanceSpecification_MolecularWeight
SubstanceSpecification relationship A link between this substance and another, with details of the relationship. SubstanceSpecification_Relationship
SubstanceSpecification nucleicAcid Data items specific to nucleic acids. Reference
SubstanceSpecification polymer Data items specific to polymers. Reference
SubstanceSpecification protein Data items specific to proteins. Reference
SubstanceSpecification sourceMaterial Material or taxonomic/anatomical source for the substance. Reference
SubstanceSpecification_Code id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Code extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Code modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Code code The specific code. CodeableConcept
SubstanceSpecification_Code status Status of the code assignment. CodeableConcept
SubstanceSpecification_Code statusDate The date at which the code status is changed as part of the terminology maintenance. dateTime
SubstanceSpecification_Code _statusDate Extensions for statusDate Element
SubstanceSpecification_Code comment Any comment can be provided in this field, if necessary. string
SubstanceSpecification_Code _comment Extensions for comment Element
SubstanceSpecification_Code source Supporting literature. Reference
SubstanceSpecification_Isotope id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Isotope extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Isotope modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Isotope identifier Substance identifier for each non-natural or radioisotope. Identifier
SubstanceSpecification_Isotope name Substance name for each non-natural or radioisotope. CodeableConcept
SubstanceSpecification_Isotope substitution The type of isotopic substitution present in a single substance. CodeableConcept
SubstanceSpecification_Isotope halfLife Half life - for a non-natural nuclide. Quantity
SubstanceSpecification_Isotope molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids). SubstanceSpecification_MolecularWeight
SubstanceSpecification_Moiety id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Moiety extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Moiety modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Moiety role Role that the moiety is playing. CodeableConcept
SubstanceSpecification_Moiety identifier Identifier by which this moiety substance is known. Identifier
SubstanceSpecification_Moiety name Textual name for this moiety substance. string
SubstanceSpecification_Moiety _name Extensions for name Element
SubstanceSpecification_Moiety stereochemistry Stereochemistry type. CodeableConcept
SubstanceSpecification_Moiety opticalActivity Optical activity type. CodeableConcept
SubstanceSpecification_Moiety molecularFormula Molecular formula. string
SubstanceSpecification_Moiety _molecularFormula Extensions for molecularFormula Element
SubstanceSpecification_Moiety amountQuantity Quantitative value for this moiety. Quantity
SubstanceSpecification_Moiety amountString Quantitative value for this moiety. notDefined
SubstanceSpecification_Moiety _amountString Extensions for amountString Element
SubstanceSpecification_MolecularWeight id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_MolecularWeight extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_MolecularWeight modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_MolecularWeight method The method by which the molecular weight was determined. CodeableConcept
SubstanceSpecification_MolecularWeight type Type of molecular weight such as exact, average (also known as. number average), weight average. CodeableConcept
SubstanceSpecification_MolecularWeight amount 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. Quantity
SubstanceSpecification_Name id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Name extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Name modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Name name The actual name. string
SubstanceSpecification_Name _name Extensions for name Element
SubstanceSpecification_Name type Name type. CodeableConcept
SubstanceSpecification_Name status The status of the name. CodeableConcept
SubstanceSpecification_Name preferred If this is the preferred name for this substance. boolean
SubstanceSpecification_Name _preferred Extensions for preferred Element
SubstanceSpecification_Name language Language of the name. CodeableConcept
SubstanceSpecification_Name domain 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. CodeableConcept
SubstanceSpecification_Name jurisdiction The jurisdiction where this name applies. CodeableConcept
SubstanceSpecification_Name synonym A synonym of this name. SubstanceSpecification_Name
SubstanceSpecification_Name translation A translation for this name. SubstanceSpecification_Name
SubstanceSpecification_Name official Details of the official nature of this name. SubstanceSpecification_Official
SubstanceSpecification_Name source Supporting literature. Reference
SubstanceSpecification_Official id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Official extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Official modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Official authority Which authority uses this official name. CodeableConcept
SubstanceSpecification_Official status The status of the official name. CodeableConcept
SubstanceSpecification_Official date Date of official name change. dateTime
SubstanceSpecification_Official _date Extensions for date Element
SubstanceSpecification_Property id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Property extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Property modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Property category A category for this property, e.g. Physical, Chemical, Enzymatic. CodeableConcept
SubstanceSpecification_Property code Property type e.g. viscosity, pH, isoelectric point. CodeableConcept
SubstanceSpecification_Property parameters Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1). string
SubstanceSpecification_Property _parameters Extensions for parameters Element
SubstanceSpecification_Property definingSubstanceReference A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). Reference
SubstanceSpecification_Property definingSubstanceCodeableConcept A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). CodeableConcept
SubstanceSpecification_Property amountQuantity Quantitative value for this property. Quantity
SubstanceSpecification_Property amountString Quantitative value for this property. notDefined
SubstanceSpecification_Property _amountString Extensions for amountString Element
SubstanceSpecification_Relationship id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Relationship extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Relationship modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Relationship substanceReference A pointer to another substance, as a resource or just a representational code. Reference
SubstanceSpecification_Relationship substanceCodeableConcept A pointer to another substance, as a resource or just a representational code. CodeableConcept
SubstanceSpecification_Relationship relationship For example "salt to parent", "active moiety", "starting material". CodeableConcept
SubstanceSpecification_Relationship isDefining 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. boolean
SubstanceSpecification_Relationship _isDefining Extensions for isDefining Element
SubstanceSpecification_Relationship amountQuantity 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. Quantity
SubstanceSpecification_Relationship amountRange 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. Range
SubstanceSpecification_Relationship amountRatio 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. Ratio
SubstanceSpecification_Relationship amountString 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. notDefined
SubstanceSpecification_Relationship _amountString Extensions for amountString Element
SubstanceSpecification_Relationship amountRatioLowLimit For use when the numeric. Ratio
SubstanceSpecification_Relationship amountType An operator for the amount, for example "average", "approximately", "less than". CodeableConcept
SubstanceSpecification_Relationship source Supporting literature. Reference
SubstanceSpecification_Representation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Representation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Representation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Representation type The type of structure (e.g. Full, Partial, Representative). CodeableConcept
SubstanceSpecification_Representation representation The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX. string
SubstanceSpecification_Representation _representation Extensions for representation Element
SubstanceSpecification_Representation attachment An attached file with the structural representation. Attachment
SubstanceSpecification_Structure id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SubstanceSpecification_Structure extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SubstanceSpecification_Structure modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SubstanceSpecification_Structure stereochemistry Stereochemistry type. CodeableConcept
SubstanceSpecification_Structure opticalActivity Optical activity type. CodeableConcept
SubstanceSpecification_Structure molecularFormula Molecular formula. string
SubstanceSpecification_Structure _molecularFormula Extensions for molecularFormula Element
SubstanceSpecification_Structure molecularFormulaByMoiety Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot. string
SubstanceSpecification_Structure _molecularFormulaByMoiety Extensions for molecularFormulaByMoiety Element
SubstanceSpecification_Structure isotope Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio. SubstanceSpecification_Isotope
SubstanceSpecification_Structure molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids). SubstanceSpecification_MolecularWeight
SubstanceSpecification_Structure source Supporting literature. Reference
SubstanceSpecification_Structure representation Molecular structural representation. SubstanceSpecification_Representation
Substance_Ingredient id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Substance_Ingredient extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Substance_Ingredient modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Substance_Ingredient quantity The amount of the ingredient in the substance - a concentration ratio. Ratio
Substance_Ingredient substanceCodeableConcept Another substance that is a component of this substance. CodeableConcept
Substance_Ingredient substanceReference Another substance that is a component of this substance. Reference
Substance_Instance id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Substance_Instance extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Substance_Instance modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Substance_Instance identifier Identifier associated with the package/container (usually a label affixed directly). Identifier
Substance_Instance expiry When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. dateTime
Substance_Instance _expiry Extensions for expiry Element
Substance_Instance quantity The amount of the substance. Quantity
SupplyDelivery resourceType This is a SupplyDelivery resource SupplyDelivery
SupplyDelivery id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SupplyDelivery meta 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. Meta
SupplyDelivery implicitRules 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. uri
SupplyDelivery _implicitRules Extensions for implicitRules Element
SupplyDelivery language The base language in which the resource is written. code
SupplyDelivery _language Extensions for language Element
SupplyDelivery text 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. Narrative
SupplyDelivery contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SupplyDelivery extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SupplyDelivery modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SupplyDelivery identifier Identifier for the supply delivery event that is used to identify it across multiple disparate systems. Identifier
SupplyDelivery basedOn A plan, proposal or order that is fulfilled in whole or in part by this event. Reference
SupplyDelivery partOf A larger event of which this particular event is a component or step. Reference
SupplyDelivery status A code specifying the state of the dispense event. enum values:
in-progress
completed
abandoned
entered-in-error
SupplyDelivery _status Extensions for status Element
SupplyDelivery patient A link to a resource representing the person whom the delivered item is for. Reference
SupplyDelivery type Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. CodeableConcept
SupplyDelivery suppliedItem The item that is being delivered or has been supplied. SupplyDelivery_SuppliedItem
SupplyDelivery occurrenceDateTime The date or time(s) the activity occurred. notDefined
SupplyDelivery _occurrenceDateTime Extensions for occurrenceDateTime Element
SupplyDelivery occurrencePeriod The date or time(s) the activity occurred. Period
SupplyDelivery occurrenceTiming The date or time(s) the activity occurred. Timing
SupplyDelivery supplier The individual responsible for dispensing the medication, supplier or device. Reference
SupplyDelivery destination Identification of the facility/location where the Supply was shipped to, as part of the dispense event. Reference
SupplyDelivery receiver Identifies the person who picked up the Supply. Reference
SupplyDelivery_SuppliedItem id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SupplyDelivery_SuppliedItem extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SupplyDelivery_SuppliedItem modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SupplyDelivery_SuppliedItem quantity The amount of supply that has been dispensed. Includes unit of measure. Quantity
SupplyDelivery_SuppliedItem itemCodeableConcept Identifies the medication, substance or device being dispensed. 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. CodeableConcept
SupplyDelivery_SuppliedItem itemReference Identifies the medication, substance or device being dispensed. 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. Reference
SupplyRequest resourceType This is a SupplyRequest resource SupplyRequest
SupplyRequest id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
SupplyRequest meta 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. Meta
SupplyRequest implicitRules 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. uri
SupplyRequest _implicitRules Extensions for implicitRules Element
SupplyRequest language The base language in which the resource is written. code
SupplyRequest _language Extensions for language Element
SupplyRequest text 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. Narrative
SupplyRequest contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
SupplyRequest extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SupplyRequest modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SupplyRequest identifier 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. Identifier
SupplyRequest status Status of the supply request. enum values:
draft
active
suspended
cancelled
completed
entered-in-error
unknown
SupplyRequest _status Extensions for status Element
SupplyRequest category Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. CodeableConcept
SupplyRequest priority Indicates how quickly this SupplyRequest should be addressed with respect to other requests. code
SupplyRequest _priority Extensions for priority Element
SupplyRequest itemCodeableConcept 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. CodeableConcept
SupplyRequest itemReference 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. Reference
SupplyRequest quantity The amount that is being ordered of the indicated item. Quantity
SupplyRequest parameter Specific parameters for the ordered item. For example, the size of the indicated item. SupplyRequest_Parameter
SupplyRequest occurrenceDateTime When the request should be fulfilled. notDefined
SupplyRequest _occurrenceDateTime Extensions for occurrenceDateTime Element
SupplyRequest occurrencePeriod When the request should be fulfilled. Period
SupplyRequest occurrenceTiming When the request should be fulfilled. Timing
SupplyRequest authoredOn When the request was made. dateTime
SupplyRequest _authoredOn Extensions for authoredOn Element
SupplyRequest requester The device, practitioner, etc. who initiated the request. Reference
SupplyRequest supplier Who is intended to fulfill the request. Reference
SupplyRequest reasonCode The reason why the supply item was requested. CodeableConcept
SupplyRequest reasonReference The reason why the supply item was requested. Reference
SupplyRequest deliverFrom Where the supply is expected to come from. Reference
SupplyRequest deliverTo Where the supply is destined to go. Reference
SupplyRequest_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
SupplyRequest_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
SupplyRequest_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
SupplyRequest_Parameter code A code or string that identifies the device detail being asserted. CodeableConcept
SupplyRequest_Parameter valueCodeableConcept The value of the device detail. CodeableConcept
SupplyRequest_Parameter valueQuantity The value of the device detail. Quantity
SupplyRequest_Parameter valueRange The value of the device detail. Range
SupplyRequest_Parameter valueBoolean The value of the device detail. notDefined
SupplyRequest_Parameter _valueBoolean Extensions for valueBoolean Element
Task resourceType This is a Task resource Task
Task id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
Task meta 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. Meta
Task implicitRules 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. uri
Task _implicitRules Extensions for implicitRules Element
Task language The base language in which the resource is written. code
Task _language Extensions for language Element
Task text 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. Narrative
Task contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
Task extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Task modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Task identifier The business identifier for this task. Identifier
Task instantiatesCanonical 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. canonical
Task instantiatesUri 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. uri
Task _instantiatesUri Extensions for instantiatesUri Element
Task basedOn BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. Reference
Task groupIdentifier An identifier that links together multiple tasks and other requests that were created in the same context. Identifier
Task partOf Task that this particular task is part of. Reference
Task status The current status of the task. enum values:
draft
requested
received
accepted
rejected
ready
cancelled
in-progress
on-hold
failed
completed
entered-in-error
Task _status Extensions for status Element
Task statusReason An explanation as to why this task is held, failed, was refused, etc. CodeableConcept
Task businessStatus Contains business-specific nuances of the business state. CodeableConcept
Task intent 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. enum values:
unknown
proposal
plan
order
original-order
reflex-order
filler-order
instance-order
option
Task _intent Extensions for intent Element
Task priority Indicates how quickly the Task should be addressed with respect to other requests. code
Task _priority Extensions for priority Element
Task code A name or code (or both) briefly describing what the task involves. CodeableConcept
Task description A free-text description of what is to be performed. string
Task _description Extensions for description Element
Task focus The request being actioned or the resource being manipulated by this task. Reference
Task for The entity who benefits from the performance of the service specified in the task (e.g., the patient). Reference
Task encounter The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. Reference
Task executionPeriod 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). Period
Task authoredOn The date and time this task was created. dateTime
Task _authoredOn Extensions for authoredOn Element
Task lastModified The date and time of last modification to this task. dateTime
Task _lastModified Extensions for lastModified Element
Task requester The creator of the task. Reference
Task performerType The kind of participant that should perform the task. CodeableConcept
Task owner Individual organization or Device currently responsible for task execution. Reference
Task location Principal physical location where the this task is performed. Reference
Task reasonCode A description or code indicating why this task needs to be performed. CodeableConcept
Task reasonReference A resource reference indicating why this task needs to be performed. Reference
Task insurance Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. Reference
Task note Free-text information captured about the task as it progresses. Annotation
Task relevantHistory 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. Reference
Task restriction 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
Task input Additional information that may be needed in the execution of the task. Task_Input
Task output Outputs produced by the Task. Task_Output
Task_Input id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Task_Input extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Task_Input modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Task_Input type A code or description indicating how the input is intended to be used as part of the task execution. CodeableConcept
Task_Input valueBase64Binary The value of the input parameter as a basic type. notDefined
Task_Input _valueBase64Binary Extensions for valueBase64Binary Element
Task_Input valueBoolean The value of the input parameter as a basic type. notDefined
Task_Input _valueBoolean Extensions for valueBoolean Element
Task_Input valueCanonical The value of the input parameter as a basic type. notDefined
Task_Input _valueCanonical Extensions for valueCanonical Element
Task_Input valueCode The value of the input parameter as a basic type. notDefined
Task_Input _valueCode Extensions for valueCode Element
Task_Input valueDate The value of the input parameter as a basic type. notDefined
Task_Input _valueDate Extensions for valueDate Element
Task_Input valueDateTime The value of the input parameter as a basic type. notDefined
Task_Input _valueDateTime Extensions for valueDateTime Element
Task_Input valueDecimal The value of the input parameter as a basic type. notDefined
Task_Input _valueDecimal Extensions for valueDecimal Element
Task_Input valueId The value of the input parameter as a basic type. notDefined
Task_Input _valueId Extensions for valueId Element
Task_Input valueInstant The value of the input parameter as a basic type. notDefined
Task_Input _valueInstant Extensions for valueInstant Element
Task_Input valueInteger The value of the input parameter as a basic type. notDefined
Task_Input _valueInteger Extensions for valueInteger Element
Task_Input valueMarkdown The value of the input parameter as a basic type. notDefined
Task_Input _valueMarkdown Extensions for valueMarkdown Element
Task_Input valueOid The value of the input parameter as a basic type. notDefined
Task_Input _valueOid Extensions for valueOid Element
Task_Input valuePositiveInt The value of the input parameter as a basic type. notDefined
Task_Input _valuePositiveInt Extensions for valuePositiveInt Element
Task_Input valueString The value of the input parameter as a basic type. notDefined
Task_Input _valueString Extensions for valueString Element
Task_Input valueTime The value of the input parameter as a basic type. notDefined
Task_Input _valueTime Extensions for valueTime Element
Task_Input valueUnsignedInt The value of the input parameter as a basic type. notDefined
Task_Input _valueUnsignedInt Extensions for valueUnsignedInt Element
Task_Input valueUri The value of the input parameter as a basic type. notDefined
Task_Input _valueUri Extensions for valueUri Element
Task_Input valueUrl The value of the input parameter as a basic type. notDefined
Task_Input _valueUrl Extensions for valueUrl Element
Task_Input valueUuid The value of the input parameter as a basic type. notDefined
Task_Input _valueUuid Extensions for valueUuid Element
Task_Input valueAddress The value of the input parameter as a basic type. Address
Task_Input valueAge The value of the input parameter as a basic type. Age
Task_Input valueAnnotation The value of the input parameter as a basic type. Annotation
Task_Input valueAttachment The value of the input parameter as a basic type. Attachment
Task_Input valueCodeableConcept The value of the input parameter as a basic type. CodeableConcept
Task_Input valueCoding The value of the input parameter as a basic type. Coding
Task_Input valueContactPoint The value of the input parameter as a basic type. ContactPoint
Task_Input valueCount The value of the input parameter as a basic type. Count
Task_Input valueDistance The value of the input parameter as a basic type. Distance
Task_Input valueDuration The value of the input parameter as a basic type. Duration
Task_Input valueHumanName The value of the input parameter as a basic type. HumanName
Task_Input valueIdentifier The value of the input parameter as a basic type. Identifier
Task_Input valueMoney The value of the input parameter as a basic type. Money
Task_Input valuePeriod The value of the input parameter as a basic type. Period
Task_Input valueQuantity The value of the input parameter as a basic type. Quantity
Task_Input valueRange The value of the input parameter as a basic type. Range
Task_Input valueRatio The value of the input parameter as a basic type. Ratio
Task_Input valueReference The value of the input parameter as a basic type. Reference
Task_Input valueSampledData The value of the input parameter as a basic type. SampledData
Task_Input valueSignature The value of the input parameter as a basic type. Signature
Task_Input valueTiming The value of the input parameter as a basic type. Timing
Task_Input valueContactDetail The value of the input parameter as a basic type. ContactDetail
Task_Input valueContributor The value of the input parameter as a basic type. Contributor
Task_Input valueDataRequirement The value of the input parameter as a basic type. DataRequirement
Task_Input valueExpression The value of the input parameter as a basic type. Expression
Task_Input valueParameterDefinition The value of the input parameter as a basic type. ParameterDefinition
Task_Input valueRelatedArtifact The value of the input parameter as a basic type. RelatedArtifact
Task_Input valueTriggerDefinition The value of the input parameter as a basic type. TriggerDefinition
Task_Input valueUsageContext The value of the input parameter as a basic type. UsageContext
Task_Input valueDosage The value of the input parameter as a basic type. Dosage
Task_Output id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Task_Output extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Task_Output modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Task_Output type The name of the Output parameter. CodeableConcept
Task_Output valueBase64Binary The value of the Output parameter as a basic type. notDefined
Task_Output _valueBase64Binary Extensions for valueBase64Binary Element
Task_Output valueBoolean The value of the Output parameter as a basic type. notDefined
Task_Output _valueBoolean Extensions for valueBoolean Element
Task_Output valueCanonical The value of the Output parameter as a basic type. notDefined
Task_Output _valueCanonical Extensions for valueCanonical Element
Task_Output valueCode The value of the Output parameter as a basic type. notDefined
Task_Output _valueCode Extensions for valueCode Element
Task_Output valueDate The value of the Output parameter as a basic type. notDefined
Task_Output _valueDate Extensions for valueDate Element
Task_Output valueDateTime The value of the Output parameter as a basic type. notDefined
Task_Output _valueDateTime Extensions for valueDateTime Element
Task_Output valueDecimal The value of the Output parameter as a basic type. notDefined
Task_Output _valueDecimal Extensions for valueDecimal Element
Task_Output valueId The value of the Output parameter as a basic type. notDefined
Task_Output _valueId Extensions for valueId Element
Task_Output valueInstant The value of the Output parameter as a basic type. notDefined
Task_Output _valueInstant Extensions for valueInstant Element
Task_Output valueInteger The value of the Output parameter as a basic type. notDefined
Task_Output _valueInteger Extensions for valueInteger Element
Task_Output valueMarkdown The value of the Output parameter as a basic type. notDefined
Task_Output _valueMarkdown Extensions for valueMarkdown Element
Task_Output valueOid The value of the Output parameter as a basic type. notDefined
Task_Output _valueOid Extensions for valueOid Element
Task_Output valuePositiveInt The value of the Output parameter as a basic type. notDefined
Task_Output _valuePositiveInt Extensions for valuePositiveInt Element
Task_Output valueString The value of the Output parameter as a basic type. notDefined
Task_Output _valueString Extensions for valueString Element
Task_Output valueTime The value of the Output parameter as a basic type. notDefined
Task_Output _valueTime Extensions for valueTime Element
Task_Output valueUnsignedInt The value of the Output parameter as a basic type. notDefined
Task_Output _valueUnsignedInt Extensions for valueUnsignedInt Element
Task_Output valueUri The value of the Output parameter as a basic type. notDefined
Task_Output _valueUri Extensions for valueUri Element
Task_Output valueUrl The value of the Output parameter as a basic type. notDefined
Task_Output _valueUrl Extensions for valueUrl Element
Task_Output valueUuid The value of the Output parameter as a basic type. notDefined
Task_Output _valueUuid Extensions for valueUuid Element
Task_Output valueAddress The value of the Output parameter as a basic type. Address
Task_Output valueAge The value of the Output parameter as a basic type. Age
Task_Output valueAnnotation The value of the Output parameter as a basic type. Annotation
Task_Output valueAttachment The value of the Output parameter as a basic type. Attachment
Task_Output valueCodeableConcept The value of the Output parameter as a basic type. CodeableConcept
Task_Output valueCoding The value of the Output parameter as a basic type. Coding
Task_Output valueContactPoint The value of the Output parameter as a basic type. ContactPoint
Task_Output valueCount The value of the Output parameter as a basic type. Count
Task_Output valueDistance The value of the Output parameter as a basic type. Distance
Task_Output valueDuration The value of the Output parameter as a basic type. Duration
Task_Output valueHumanName The value of the Output parameter as a basic type. HumanName
Task_Output valueIdentifier The value of the Output parameter as a basic type. Identifier
Task_Output valueMoney The value of the Output parameter as a basic type. Money
Task_Output valuePeriod The value of the Output parameter as a basic type. Period
Task_Output valueQuantity The value of the Output parameter as a basic type. Quantity
Task_Output valueRange The value of the Output parameter as a basic type. Range
Task_Output valueRatio The value of the Output parameter as a basic type. Ratio
Task_Output valueReference The value of the Output parameter as a basic type. Reference
Task_Output valueSampledData The value of the Output parameter as a basic type. SampledData
Task_Output valueSignature The value of the Output parameter as a basic type. Signature
Task_Output valueTiming The value of the Output parameter as a basic type. Timing
Task_Output valueContactDetail The value of the Output parameter as a basic type. ContactDetail
Task_Output valueContributor The value of the Output parameter as a basic type. Contributor
Task_Output valueDataRequirement The value of the Output parameter as a basic type. DataRequirement
Task_Output valueExpression The value of the Output parameter as a basic type. Expression
Task_Output valueParameterDefinition The value of the Output parameter as a basic type. ParameterDefinition
Task_Output valueRelatedArtifact The value of the Output parameter as a basic type. RelatedArtifact
Task_Output valueTriggerDefinition The value of the Output parameter as a basic type. TriggerDefinition
Task_Output valueUsageContext The value of the Output parameter as a basic type. UsageContext
Task_Output valueDosage The value of the Output parameter as a basic type. Dosage
Task_Restriction id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Task_Restriction extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Task_Restriction modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Task_Restriction repetitions Indicates the number of times the requested action should occur. positiveInt
Task_Restriction _repetitions Extensions for repetitions Element
Task_Restriction period Over what time-period is fulfillment sought. Period
Task_Restriction recipient For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? Reference
TerminologyCapabilities resourceType This is a TerminologyCapabilities resource TerminologyCapabilities
TerminologyCapabilities id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
TerminologyCapabilities meta 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. Meta
TerminologyCapabilities implicitRules 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. uri
TerminologyCapabilities _implicitRules Extensions for implicitRules Element
TerminologyCapabilities language The base language in which the resource is written. code
TerminologyCapabilities _language Extensions for language Element
TerminologyCapabilities text 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. Narrative
TerminologyCapabilities contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
TerminologyCapabilities extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities url 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 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. uri
TerminologyCapabilities _url Extensions for url Element
TerminologyCapabilities version 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. string
TerminologyCapabilities _version Extensions for version Element
TerminologyCapabilities name 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. string
TerminologyCapabilities _name Extensions for name Element
TerminologyCapabilities title A short, descriptive, user-friendly title for the terminology capabilities. string
TerminologyCapabilities _title Extensions for title Element
TerminologyCapabilities status The status of this terminology capabilities. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
TerminologyCapabilities _status Extensions for status Element
TerminologyCapabilities experimental 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. boolean
TerminologyCapabilities _experimental Extensions for experimental Element
TerminologyCapabilities date The date (and optionally time) when the terminology capabilities 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 terminology capabilities changes. dateTime
TerminologyCapabilities _date Extensions for date Element
TerminologyCapabilities publisher The name of the organization or individual that published the terminology capabilities. string
TerminologyCapabilities _publisher Extensions for publisher Element
TerminologyCapabilities contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
TerminologyCapabilities description 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. markdown
TerminologyCapabilities _description Extensions for description Element
TerminologyCapabilities useContext 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. UsageContext
TerminologyCapabilities jurisdiction A legal or geographic region in which the terminology capabilities is intended to be used. CodeableConcept
TerminologyCapabilities purpose Explanation of why this terminology capabilities is needed and why it has been designed as it has. markdown
TerminologyCapabilities _purpose Extensions for purpose Element
TerminologyCapabilities copyright 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. markdown
TerminologyCapabilities _copyright Extensions for copyright Element
TerminologyCapabilities kind 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). code
TerminologyCapabilities _kind Extensions for kind Element
TerminologyCapabilities software 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
TerminologyCapabilities implementation 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
TerminologyCapabilities lockedDate Whether the server supports lockedDate. boolean
TerminologyCapabilities _lockedDate Extensions for lockedDate Element
TerminologyCapabilities codeSystem 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. TerminologyCapabilities_CodeSystem
TerminologyCapabilities expansion Information about the [ValueSet/$expand](valueset-operation-expand.html) operation. TerminologyCapabilities_Expansion
TerminologyCapabilities codeSearch The degree to which the server supports the code search parameter on ValueSet, if it is supported. enum values:
explicit
all
TerminologyCapabilities _codeSearch Extensions for codeSearch Element
TerminologyCapabilities validateCode Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation. TerminologyCapabilities_ValidateCode
TerminologyCapabilities translation Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation. TerminologyCapabilities_Translation
TerminologyCapabilities closure Whether the $closure operation is supported. TerminologyCapabilities_Closure
TerminologyCapabilities_Closure id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Closure extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Closure modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Closure translation If cross-system closure is supported. boolean
TerminologyCapabilities_Closure _translation Extensions for translation Element
TerminologyCapabilities_CodeSystem id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_CodeSystem extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_CodeSystem modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_CodeSystem uri URI for the Code System. canonical
TerminologyCapabilities_CodeSystem version For the code system, a list of versions that are supported by the server. TerminologyCapabilities_Version
TerminologyCapabilities_CodeSystem subsumption True if subsumption is supported for this version of the code system. boolean
TerminologyCapabilities_CodeSystem _subsumption Extensions for subsumption Element
TerminologyCapabilities_Expansion id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Expansion extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Expansion modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Expansion hierarchical Whether the server can return nested value sets. boolean
TerminologyCapabilities_Expansion _hierarchical Extensions for hierarchical Element
TerminologyCapabilities_Expansion paging Whether the server supports paging on expansion. boolean
TerminologyCapabilities_Expansion _paging Extensions for paging Element
TerminologyCapabilities_Expansion incomplete Allow request for incomplete expansions? boolean
TerminologyCapabilities_Expansion _incomplete Extensions for incomplete Element
TerminologyCapabilities_Expansion parameter Supported expansion parameter. TerminologyCapabilities_Parameter
TerminologyCapabilities_Expansion textFilter Documentation about text searching works. markdown
TerminologyCapabilities_Expansion _textFilter Extensions for textFilter Element
TerminologyCapabilities_Filter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Filter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Filter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Filter code Code of the property supported. code
TerminologyCapabilities_Filter _code Extensions for code Element
TerminologyCapabilities_Filter op Operations supported for the property. code
TerminologyCapabilities_Filter _op Extensions for op Element
TerminologyCapabilities_Implementation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Implementation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Implementation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Implementation description Information about the specific installation that this terminology capability statement relates to. string
TerminologyCapabilities_Implementation _description Extensions for description Element
TerminologyCapabilities_Implementation url An absolute base URL for the implementation. url
TerminologyCapabilities_Implementation _url Extensions for url Element
TerminologyCapabilities_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Parameter name Expansion Parameter name. code
TerminologyCapabilities_Parameter _name Extensions for name Element
TerminologyCapabilities_Parameter documentation Description of support for parameter. string
TerminologyCapabilities_Parameter _documentation Extensions for documentation Element
TerminologyCapabilities_Software id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Software extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Software modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Software name Name the software is known by. string
TerminologyCapabilities_Software _name Extensions for name Element
TerminologyCapabilities_Software version The version identifier for the software covered by this statement. string
TerminologyCapabilities_Software _version Extensions for version Element
TerminologyCapabilities_Translation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Translation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Translation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Translation needsMap Whether the client must identify the map. boolean
TerminologyCapabilities_Translation _needsMap Extensions for needsMap Element
TerminologyCapabilities_ValidateCode id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_ValidateCode extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_ValidateCode modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_ValidateCode translations Whether translations are validated. boolean
TerminologyCapabilities_ValidateCode _translations Extensions for translations Element
TerminologyCapabilities_Version id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TerminologyCapabilities_Version extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TerminologyCapabilities_Version modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TerminologyCapabilities_Version code For version-less code systems, there should be a single version with no identifier. string
TerminologyCapabilities_Version _code Extensions for code Element
TerminologyCapabilities_Version isDefault If this is the default version for this code system. boolean
TerminologyCapabilities_Version _isDefault Extensions for isDefault Element
TerminologyCapabilities_Version compositional If the compositional grammar defined by the code system is supported. boolean
TerminologyCapabilities_Version _compositional Extensions for compositional Element
TerminologyCapabilities_Version language Language Displays supported. code
TerminologyCapabilities_Version _language Extensions for language Element
TerminologyCapabilities_Version filter Filter Properties supported. TerminologyCapabilities_Filter
TerminologyCapabilities_Version property Properties supported for $lookup. code
TerminologyCapabilities_Version _property Extensions for property Element
TestReport resourceType This is a TestReport resource TestReport
TestReport id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
TestReport meta 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. Meta
TestReport implicitRules 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. uri
TestReport _implicitRules Extensions for implicitRules Element
TestReport language The base language in which the resource is written. code
TestReport _language Extensions for language Element
TestReport text 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. Narrative
TestReport contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
TestReport extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport identifier Identifier for the TestScript assigned for external purposes outside the context of FHIR. Identifier
TestReport name A free text natural language name identifying the executed TestScript. string
TestReport _name Extensions for name Element
TestReport status The current state of this test report. enum values:
completed
in-progress
waiting
stopped
entered-in-error
TestReport _status Extensions for status Element
TestReport testScript Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`. Reference
TestReport result The overall result from the execution of the TestScript. enum values:
pass
fail
pending
TestReport _result Extensions for result Element
TestReport score The final score (percentage of tests passed) resulting from the execution of the TestScript. decimal
TestReport _score Extensions for score Element
TestReport tester Name of the tester producing this report (Organization or individual). string
TestReport _tester Extensions for tester Element
TestReport issued When the TestScript was executed and this TestReport was generated. dateTime
TestReport _issued Extensions for issued Element
TestReport participant A participant in the test execution, either the execution engine, a client, or a server. TestReport_Participant
TestReport setup The results of the series of required setup operations before the tests were executed. TestReport_Setup
TestReport test A test executed from the test script. TestReport_Test
TestReport teardown The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise). TestReport_Teardown
TestReport_Action id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Action extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Action modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Action operation The operation performed. TestReport_Operation
TestReport_Action assert The results of the assertion performed on the previous operations. TestReport_Assert
TestReport_Action1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Action1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Action1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Action1 operation An operation would involve a REST request to a server. TestReport_Operation
TestReport_Action1 assert The results of the assertion performed on the previous operations. TestReport_Assert
TestReport_Action2 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Action2 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Action2 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Action2 operation An operation would involve a REST request to a server. TestReport_Operation
TestReport_Assert id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Assert extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Assert modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Assert result The result of this assertion. enum values:
pass
skip
fail
warning
error
TestReport_Assert _result Extensions for result Element
TestReport_Assert message An explanatory message associated with the result. markdown
TestReport_Assert _message Extensions for message Element
TestReport_Assert detail A link to further details on the result. string
TestReport_Assert _detail Extensions for detail Element
TestReport_Operation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Operation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Operation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Operation result The result of this operation. enum values:
pass
skip
fail
warning
error
TestReport_Operation _result Extensions for result Element
TestReport_Operation message An explanatory message associated with the result. markdown
TestReport_Operation _message Extensions for message Element
TestReport_Operation detail A link to further details on the result. uri
TestReport_Operation _detail Extensions for detail Element
TestReport_Participant id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Participant extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Participant modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Participant type The type of participant. enum values:
test-engine
client
server
TestReport_Participant _type Extensions for type Element
TestReport_Participant uri The uri of the participant. An absolute URL is preferred. uri
TestReport_Participant _uri Extensions for uri Element
TestReport_Participant display The display name of the participant. string
TestReport_Participant _display Extensions for display Element
TestReport_Setup id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Setup extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Setup modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Setup action Action would contain either an operation or an assertion. TestReport_Action
TestReport_Teardown id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Teardown extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Teardown modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Teardown action The teardown action will only contain an operation. TestReport_Action2
TestReport_Test id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestReport_Test extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestReport_Test modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestReport_Test name The name of this test used for tracking/logging purposes by test engines. string
TestReport_Test _name Extensions for name Element
TestReport_Test description A short description of the test used by test engines for tracking and reporting purposes. string
TestReport_Test _description Extensions for description Element
TestReport_Test action Action would contain either an operation or an assertion. TestReport_Action1
TestScript resourceType This is a TestScript resource TestScript
TestScript id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
TestScript meta 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. Meta
TestScript implicitRules 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. uri
TestScript _implicitRules Extensions for implicitRules Element
TestScript language The base language in which the resource is written. code
TestScript _language Extensions for language Element
TestScript text 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. Narrative
TestScript contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
TestScript extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript url 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 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. uri
TestScript _url Extensions for url Element
TestScript identifier 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. Identifier
TestScript version 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. string
TestScript _version Extensions for version Element
TestScript name 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. string
TestScript _name Extensions for name Element
TestScript title A short, descriptive, user-friendly title for the test script. string
TestScript _title Extensions for title Element
TestScript status The status of this test script. Enables tracking the life-cycle of the content. enum values:
draft
active
retired
unknown
TestScript _status Extensions for status Element
TestScript experimental 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. boolean
TestScript _experimental Extensions for experimental Element
TestScript date The date (and optionally time) when the test script 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 test script changes. dateTime
TestScript _date Extensions for date Element
TestScript publisher The name of the organization or individual that published the test script. string
TestScript _publisher Extensions for publisher Element
TestScript contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
TestScript description A free text natural language description of the test script from a consumer's perspective. markdown
TestScript _description Extensions for description Element
TestScript useContext 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. UsageContext
TestScript jurisdiction A legal or geographic region in which the test script is intended to be used. CodeableConcept
TestScript purpose Explanation of why this test script is needed and why it has been designed as it has. markdown
TestScript _purpose Extensions for purpose Element
TestScript copyright 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. markdown
TestScript _copyright Extensions for copyright Element
TestScript origin An abstract server used in operations within this test script in the origin element. TestScript_Origin
TestScript destination An abstract server used in operations within this test script in the destination element. TestScript_Destination
TestScript metadata The required capability must exist and are assumed to function correctly on the FHIR server being tested. TestScript_Metadata
TestScript fixture Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. TestScript_Fixture
TestScript profile Reference to the profile to be used for validation. Reference
TestScript variable Variable is set based either on element value in response body or on header field value in the response headers. TestScript_Variable
TestScript setup A series of required setup operations before tests are executed. TestScript_Setup
TestScript test A test in this script. TestScript_Test
TestScript teardown A series of operations required to clean up after all the tests are executed (successfully or otherwise). TestScript_Teardown
TestScript_Action id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Action extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Action modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Action operation The operation to perform. TestScript_Operation
TestScript_Action assert Evaluates the results of previous operations to determine if the server under test behaves appropriately. TestScript_Assert
TestScript_Action1 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Action1 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Action1 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Action1 operation An operation would involve a REST request to a server. TestScript_Operation
TestScript_Action1 assert Evaluates the results of previous operations to determine if the server under test behaves appropriately. TestScript_Assert
TestScript_Action2 id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Action2 extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Action2 modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Action2 operation An operation would involve a REST request to a server. TestScript_Operation
TestScript_Assert id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Assert extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Assert modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Assert label The label would be used for tracking/logging purposes by test engines. string
TestScript_Assert _label Extensions for label Element
TestScript_Assert description The description would be used by test engines for tracking and reporting purposes. string
TestScript_Assert _description Extensions for description Element
TestScript_Assert direction The direction to use for the assertion. enum values:
response
request
TestScript_Assert _direction Extensions for direction Element
TestScript_Assert compareToSourceId Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition. string
TestScript_Assert _compareToSourceId Extensions for compareToSourceId Element
TestScript_Assert compareToSourceExpression The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. string
TestScript_Assert _compareToSourceExpression Extensions for compareToSourceExpression Element
TestScript_Assert compareToSourcePath XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both. string
TestScript_Assert _compareToSourcePath Extensions for compareToSourcePath Element
TestScript_Assert contentType The mime-type contents to compare against the request or response message 'Content-Type' header. code
TestScript_Assert _contentType Extensions for contentType Element
TestScript_Assert expression The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload. string
TestScript_Assert _expression Extensions for expression Element
TestScript_Assert headerField The HTTP header field name e.g. 'Location'. string
TestScript_Assert _headerField Extensions for headerField Element
TestScript_Assert minimumId The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId. string
TestScript_Assert _minimumId Extensions for minimumId Element
TestScript_Assert navigationLinks Whether or not the test execution performs validation on the bundle navigation links. boolean
TestScript_Assert _navigationLinks Extensions for navigationLinks Element
TestScript_Assert operator The operator type defines the conditional behavior of the assert. If not defined, the default is equals. enum values:
equals
notEquals
in
notIn
greaterThan
lessThan
empty
notEmpty
contains
notContains
eval
TestScript_Assert _operator Extensions for operator Element
TestScript_Assert path The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. string
TestScript_Assert _path Extensions for path Element
TestScript_Assert requestMethod The request method or HTTP operation code to compare against that used by the client system under test. enum values:
delete
get
options
patch
post
put
head
TestScript_Assert _requestMethod Extensions for requestMethod Element
TestScript_Assert requestURL The value to use in a comparison against the request URL path string. string
TestScript_Assert _requestURL Extensions for requestURL Element
TestScript_Assert resource The type of the resource. See http://build.fhir.org/resourcelist.html. code
TestScript_Assert _resource Extensions for resource Element
TestScript_Assert response okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable. enum values:
okay
created
noContent
notModified
bad
forbidden
notFound
methodNotAllowed
conflict
gone
preconditionFailed
unprocessable
TestScript_Assert _response Extensions for response Element
TestScript_Assert responseCode The value of the HTTP response code to be tested. string
TestScript_Assert _responseCode Extensions for responseCode Element
TestScript_Assert sourceId Fixture to evaluate the XPath/JSONPath expression or the headerField against. id
TestScript_Assert _sourceId Extensions for sourceId Element
TestScript_Assert validateProfileId The ID of the Profile to validate against. id
TestScript_Assert _validateProfileId Extensions for validateProfileId Element
TestScript_Assert value The value to compare to. string
TestScript_Assert _value Extensions for value Element
TestScript_Assert warningOnly Whether or not the test execution will produce a warning only on error for this assert. boolean
TestScript_Assert _warningOnly Extensions for warningOnly Element
TestScript_Capability id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Capability extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Capability modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Capability required Whether or not the test execution will require the given capabilities of the server in order for this test script to execute. boolean
TestScript_Capability _required Extensions for required Element
TestScript_Capability validated Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute. boolean
TestScript_Capability _validated Extensions for validated Element
TestScript_Capability description Description of the capabilities that this test script is requiring the server to support. string
TestScript_Capability _description Extensions for description Element
TestScript_Capability origin Which origin server these requirements apply to. integer
TestScript_Capability _origin Extensions for origin Element
TestScript_Capability destination Which server these requirements apply to. integer
TestScript_Capability _destination Extensions for destination Element
TestScript_Capability link Links to the FHIR specification that describes this interaction and the resources involved in more detail. uri
TestScript_Capability _link Extensions for link Element
TestScript_Capability capabilities 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. canonical
TestScript_Destination id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Destination extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Destination modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Destination index Abstract name given to a destination server in this test script. The name is provided as a number starting at 1. integer
TestScript_Destination _index Extensions for index Element
TestScript_Destination profile The type of destination profile the test system supports. Coding
TestScript_Fixture id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Fixture extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Fixture modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Fixture autocreate 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. boolean
TestScript_Fixture _autocreate Extensions for autocreate Element
TestScript_Fixture autodelete 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. boolean
TestScript_Fixture _autodelete Extensions for autodelete Element
TestScript_Fixture resource Reference to the resource (containing the contents of the resource needed for operations). Reference
TestScript_Link id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Link extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Link modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Link url URL to a particular requirement or feature within the FHIR specification. uri
TestScript_Link _url Extensions for url Element
TestScript_Link description Short description of the link. string
TestScript_Link _description Extensions for description Element
TestScript_Metadata id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Metadata extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Metadata modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Metadata link A link to the FHIR specification that this test is covering. TestScript_Link
TestScript_Metadata capability Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. TestScript_Capability
TestScript_Operation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Operation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Operation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Operation type Server interaction or operation type. Coding
TestScript_Operation resource The type of the resource. See http://build.fhir.org/resourcelist.html. code
TestScript_Operation _resource Extensions for resource Element
TestScript_Operation label The label would be used for tracking/logging purposes by test engines. string
TestScript_Operation _label Extensions for label Element
TestScript_Operation description The description would be used by test engines for tracking and reporting purposes. string
TestScript_Operation _description Extensions for description Element
TestScript_Operation accept The mime-type to use for RESTful operation in the 'Accept' header. code
TestScript_Operation _accept Extensions for accept Element
TestScript_Operation contentType The mime-type to use for RESTful operation in the 'Content-Type' header. code
TestScript_Operation _contentType Extensions for contentType Element
TestScript_Operation destination The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section. integer
TestScript_Operation _destination Extensions for destination Element
TestScript_Operation encodeRequestUrl 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. boolean
TestScript_Operation _encodeRequestUrl Extensions for encodeRequestUrl Element
TestScript_Operation method The HTTP method the test engine MUST use for this operation regardless of any other operation details. enum values:
delete
get
options
patch
post
put
head
TestScript_Operation _method Extensions for method Element
TestScript_Operation origin The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section. integer
TestScript_Operation _origin Extensions for origin Element
TestScript_Operation params Path plus parameters after [type]. Used to set parts of the request URL explicitly. string
TestScript_Operation _params Extensions for params Element
TestScript_Operation requestHeader Header elements would be used to set HTTP headers. TestScript_RequestHeader
TestScript_Operation requestId The fixture id (maybe new) to map to the request. id
TestScript_Operation _requestId Extensions for requestId Element
TestScript_Operation responseId The fixture id (maybe new) to map to the response. id
TestScript_Operation _responseId Extensions for responseId Element
TestScript_Operation sourceId The id of the fixture used as the body of a PUT or POST request. id
TestScript_Operation _sourceId Extensions for sourceId Element
TestScript_Operation targetId Id of fixture used for extracting the [id], [type], and [vid] for GET requests. id
TestScript_Operation _targetId Extensions for targetId Element
TestScript_Operation url Complete request URL. string
TestScript_Operation _url Extensions for url Element
TestScript_Origin id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Origin extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Origin modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Origin index Abstract name given to an origin server in this test script. The name is provided as a number starting at 1. integer
TestScript_Origin _index Extensions for index Element
TestScript_Origin profile The type of origin profile the test system supports. Coding
TestScript_RequestHeader id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_RequestHeader extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_RequestHeader modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_RequestHeader field The HTTP header field e.g. "Accept". string
TestScript_RequestHeader _field Extensions for field Element
TestScript_RequestHeader value The value of the header e.g. "application/fhir+xml". string
TestScript_RequestHeader _value Extensions for value Element
TestScript_Setup id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Setup extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Setup modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Setup action Action would contain either an operation or an assertion. TestScript_Action
TestScript_Teardown id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Teardown extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Teardown modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Teardown action The teardown action will only contain an operation. TestScript_Action2
TestScript_Test id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Test extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Test modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Test name The name of this test used for tracking/logging purposes by test engines. string
TestScript_Test _name Extensions for name Element
TestScript_Test description A short description of the test used by test engines for tracking and reporting purposes. string
TestScript_Test _description Extensions for description Element
TestScript_Test action Action would contain either an operation or an assertion. TestScript_Action1
TestScript_Variable id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TestScript_Variable extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TestScript_Variable modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
TestScript_Variable name Descriptive name for this variable. string
TestScript_Variable _name Extensions for name Element
TestScript_Variable defaultValue A default, hard-coded, or user-defined value for this variable. string
TestScript_Variable _defaultValue Extensions for defaultValue Element
TestScript_Variable description A free text natural language description of the variable and its purpose. string
TestScript_Variable _description Extensions for description Element
TestScript_Variable expression The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. string
TestScript_Variable _expression Extensions for expression Element
TestScript_Variable headerField Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. string
TestScript_Variable _headerField Extensions for headerField Element
TestScript_Variable hint Displayable text string with hint help information to the user when entering a default value. string
TestScript_Variable _hint Extensions for hint Element
TestScript_Variable path XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified. string
TestScript_Variable _path Extensions for path Element
TestScript_Variable sourceId Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. id
TestScript_Variable _sourceId Extensions for sourceId Element
Timing id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Timing extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Timing modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Timing event Identifies specific times when the event occurs. dateTime
Timing _event Extensions for event Element
Timing repeat A set of rules that describe when the event is scheduled. Timing_Repeat
Timing code 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). CodeableConcept
Timing_Repeat id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
Timing_Repeat extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
Timing_Repeat modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
Timing_Repeat boundsDuration 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. Duration
Timing_Repeat boundsRange 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. Range
Timing_Repeat boundsPeriod 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. Period
Timing_Repeat count 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. positiveInt
Timing_Repeat _count Extensions for count Element
Timing_Repeat countMax If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. positiveInt
Timing_Repeat _countMax Extensions for countMax Element
Timing_Repeat duration 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. decimal
Timing_Repeat _duration Extensions for duration Element
Timing_Repeat durationMax If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. decimal
Timing_Repeat _durationMax Extensions for durationMax Element
Timing_Repeat durationUnit The units of time for the duration, in UCUM units. enum values:
s
min
h
d
wk
mo
a
Timing_Repeat _durationUnit Extensions for durationUnit Element
Timing_Repeat frequency 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. positiveInt
Timing_Repeat _frequency Extensions for frequency Element
Timing_Repeat frequencyMax If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. positiveInt
Timing_Repeat _frequencyMax Extensions for frequencyMax Element
Timing_Repeat period Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. decimal
Timing_Repeat _period Extensions for period Element
Timing_Repeat periodMax 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. decimal
Timing_Repeat _periodMax Extensions for periodMax Element
Timing_Repeat periodUnit The units of time for the period in UCUM units. enum values:
s
min
h
d
wk
mo
a
Timing_Repeat _periodUnit Extensions for periodUnit Element
Timing_Repeat dayOfWeek If one or more days of week is provided, then the action happens only on the specified day(s). code
Timing_Repeat _dayOfWeek Extensions for dayOfWeek Element
Timing_Repeat timeOfDay Specified time of day for action to take place. time
Timing_Repeat _timeOfDay Extensions for timeOfDay Element
Timing_Repeat when An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. enum values:
MORN
MORN.early
MORN.late
NOON
AFT
AFT.early
AFT.late
EVE
EVE.early
EVE.late
NIGHT
PHS
HS
WAKE
C
CM
CD
CV
AC
ACM
ACD
ACV
PC
PCM
PCD
PCV
Timing_Repeat _when Extensions for when Element
Timing_Repeat offset 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. unsignedInt
Timing_Repeat _offset Extensions for offset Element
TriggerDefinition id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
TriggerDefinition extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
TriggerDefinition type The type of triggering event. enum values:
named-event
periodic
data-changed
data-added
data-modified
data-removed
data-accessed
data-access-ended
TriggerDefinition _type Extensions for type Element
TriggerDefinition name 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. string
TriggerDefinition _name Extensions for name Element
TriggerDefinition timingTiming The timing of the event (if this is a periodic trigger). Timing
TriggerDefinition timingReference The timing of the event (if this is a periodic trigger). Reference
TriggerDefinition timingDate The timing of the event (if this is a periodic trigger). notDefined
TriggerDefinition _timingDate Extensions for timingDate Element
TriggerDefinition timingDateTime The timing of the event (if this is a periodic trigger). notDefined
TriggerDefinition _timingDateTime Extensions for timingDateTime Element
TriggerDefinition data 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. DataRequirement
TriggerDefinition condition 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. Expression
UsageContext id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
UsageContext extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
UsageContext code A code that identifies the type of context being specified by this usage context. Coding
UsageContext valueCodeableConcept A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. CodeableConcept
UsageContext valueQuantity A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Quantity
UsageContext valueRange A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Range
UsageContext valueReference A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Reference
ValueSet resourceType This is a ValueSet resource ValueSet
ValueSet id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
ValueSet meta 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. Meta
ValueSet implicitRules 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. uri
ValueSet _implicitRules Extensions for implicitRules Element
ValueSet language The base language in which the resource is written. code
ValueSet _language Extensions for language Element
ValueSet text 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. Narrative
ValueSet contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
ValueSet extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet url 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 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. uri
ValueSet _url Extensions for url Element
ValueSet identifier 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. Identifier
ValueSet version 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. string
ValueSet _version Extensions for version Element
ValueSet name 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. string
ValueSet _name Extensions for name Element
ValueSet title A short, descriptive, user-friendly title for the value set. string
ValueSet _title Extensions for title Element
ValueSet status 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. enum values:
draft
active
retired
unknown
ValueSet _status Extensions for status Element
ValueSet experimental 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. boolean
ValueSet _experimental Extensions for experimental Element
ValueSet date The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition'). dateTime
ValueSet _date Extensions for date Element
ValueSet publisher The name of the organization or individual that published the value set. string
ValueSet _publisher Extensions for publisher Element
ValueSet contact Contact details to assist a user in finding and communicating with the publisher. ContactDetail
ValueSet description 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. markdown
ValueSet _description Extensions for description Element
ValueSet useContext 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. UsageContext
ValueSet jurisdiction A legal or geographic region in which the value set is intended to be used. CodeableConcept
ValueSet immutable If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. boolean
ValueSet _immutable Extensions for immutable Element
ValueSet purpose Explanation of why this value set is needed and why it has been designed as it has. markdown
ValueSet _purpose Extensions for purpose Element
ValueSet copyright 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. markdown
ValueSet _copyright Extensions for copyright Element
ValueSet compose 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
ValueSet expansion 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. ValueSet_Expansion
ValueSet_Compose id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Compose extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Compose modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Compose lockedDate 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. date
ValueSet_Compose _lockedDate Extensions for lockedDate Element
ValueSet_Compose inactive 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). boolean
ValueSet_Compose _inactive Extensions for inactive Element
ValueSet_Compose include Include one or more codes from a code system or other value set(s). ValueSet_Include
ValueSet_Compose exclude Exclude one or more codes from the value set based on code system filters and/or other value sets. ValueSet_Include
ValueSet_Concept id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Concept extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Concept modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Concept code Specifies a code for the concept to be included or excluded. code
ValueSet_Concept _code Extensions for code Element
ValueSet_Concept display 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. string
ValueSet_Concept _display Extensions for display Element
ValueSet_Concept designation Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. ValueSet_Designation
ValueSet_Contains id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Contains extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Contains modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Contains system An absolute URI which is the code system in which the code for this item in the expansion is defined. uri
ValueSet_Contains _system Extensions for system Element
ValueSet_Contains abstract If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. boolean
ValueSet_Contains _abstract Extensions for abstract Element
ValueSet_Contains inactive 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 an concept is inactive (and it may depend on the context of use). boolean
ValueSet_Contains _inactive Extensions for inactive Element
ValueSet_Contains version 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. string
ValueSet_Contains _version Extensions for version Element
ValueSet_Contains code 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. code
ValueSet_Contains _code Extensions for code Element
ValueSet_Contains display The recommended display for this item in the expansion. string
ValueSet_Contains _display Extensions for display Element
ValueSet_Contains designation 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. ValueSet_Designation
ValueSet_Contains contains Other codes and entries contained under this entry in the hierarchy. ValueSet_Contains
ValueSet_Designation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Designation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Designation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Designation language The language this designation is defined for. code
ValueSet_Designation _language Extensions for language Element
ValueSet_Designation use A code that represents types of uses of designations. Coding
ValueSet_Designation value The text value for this designation. string
ValueSet_Designation _value Extensions for value Element
ValueSet_Expansion id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Expansion extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Expansion modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Expansion identifier 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. uri
ValueSet_Expansion _identifier Extensions for identifier Element
ValueSet_Expansion timestamp The time at which the expansion was produced by the expanding system. dateTime
ValueSet_Expansion _timestamp Extensions for timestamp Element
ValueSet_Expansion total 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. integer
ValueSet_Expansion _total Extensions for total Element
ValueSet_Expansion offset 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. integer
ValueSet_Expansion _offset Extensions for offset Element
ValueSet_Expansion parameter 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. ValueSet_Parameter
ValueSet_Expansion contains The codes that are contained in the value set expansion. ValueSet_Contains
ValueSet_Filter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Filter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Filter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Filter property A code that identifies a property or a filter defined in the code system. code
ValueSet_Filter _property Extensions for property Element
ValueSet_Filter op The kind of operation to perform as a part of the filter criteria. enum values:
=
is-a
descendent-of
is-not-a
regex
in
not-in
generalizes
exists
ValueSet_Filter _op Extensions for op Element
ValueSet_Filter value 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'. string
ValueSet_Filter _value Extensions for value Element
ValueSet_Include id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Include extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Include modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Include system An absolute URI which is the code system from which the selected codes come from. uri
ValueSet_Include _system Extensions for system Element
ValueSet_Include version The version of the code system that the codes are selected from, or the special version '*' for all versions. string
ValueSet_Include _version Extensions for version Element
ValueSet_Include concept Specifies a concept to be included or excluded. ValueSet_Concept
ValueSet_Include filter Select concepts by specify 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, they SHALL all be true. ValueSet_Filter
ValueSet_Include valueSet 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 union of the contents of all of the referenced value sets. canonical
ValueSet_Parameter id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
ValueSet_Parameter extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
ValueSet_Parameter modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
ValueSet_Parameter name 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. string
ValueSet_Parameter _name Extensions for name Element
ValueSet_Parameter valueString The value of the parameter. notDefined
ValueSet_Parameter _valueString Extensions for valueString Element
ValueSet_Parameter valueBoolean The value of the parameter. notDefined
ValueSet_Parameter _valueBoolean Extensions for valueBoolean Element
ValueSet_Parameter valueInteger The value of the parameter. notDefined
ValueSet_Parameter _valueInteger Extensions for valueInteger Element
ValueSet_Parameter valueDecimal The value of the parameter. notDefined
ValueSet_Parameter _valueDecimal Extensions for valueDecimal Element
ValueSet_Parameter valueUri The value of the parameter. notDefined
ValueSet_Parameter _valueUri Extensions for valueUri Element
ValueSet_Parameter valueCode The value of the parameter. notDefined
ValueSet_Parameter _valueCode Extensions for valueCode Element
ValueSet_Parameter valueDateTime The value of the parameter. notDefined
ValueSet_Parameter _valueDateTime Extensions for valueDateTime Element
VerificationResult resourceType This is a VerificationResult resource VerificationResult
VerificationResult id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
VerificationResult meta 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. Meta
VerificationResult implicitRules 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. uri
VerificationResult _implicitRules Extensions for implicitRules Element
VerificationResult language The base language in which the resource is written. code
VerificationResult _language Extensions for language Element
VerificationResult text 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. Narrative
VerificationResult contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
VerificationResult extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
VerificationResult modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
VerificationResult target A resource that was validated. Reference
VerificationResult targetLocation The fhirpath location(s) within the resource that was validated. string
VerificationResult _targetLocation Extensions for targetLocation Element
VerificationResult need The frequency with which the target must be validated (none; initial; periodic). CodeableConcept
VerificationResult status The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed). code
VerificationResult _status Extensions for status Element
VerificationResult statusDate When the validation status was updated. dateTime
VerificationResult _statusDate Extensions for statusDate Element
VerificationResult validationType What the target is validated against (nothing; primary source; multiple sources). CodeableConcept
VerificationResult validationProcess The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context). CodeableConcept
VerificationResult frequency Frequency of revalidation. Timing
VerificationResult lastPerformed The date/time validation was last completed (including failed validations). dateTime
VerificationResult _lastPerformed Extensions for lastPerformed Element
VerificationResult nextScheduled The date when target is next validated, if appropriate. date
VerificationResult _nextScheduled Extensions for nextScheduled Element
VerificationResult failureAction The result if validation fails (fatal; warning; record only; none). CodeableConcept
VerificationResult primarySource Information about the primary source(s) involved in validation. VerificationResult_PrimarySource
VerificationResult attestation Information about the entity attesting to information. VerificationResult_Attestation
VerificationResult validator Information about the entity validating information. VerificationResult_Validator
VerificationResult_Attestation id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
VerificationResult_Attestation extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
VerificationResult_Attestation modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
VerificationResult_Attestation who The individual or organization attesting to information. Reference
VerificationResult_Attestation onBehalfOf When the who is asserting on behalf of another (organization or individual). Reference
VerificationResult_Attestation communicationMethod The method by which attested information was submitted/retrieved (manual; API; Push). CodeableConcept
VerificationResult_Attestation date The date the information was attested to. date
VerificationResult_Attestation _date Extensions for date Element
VerificationResult_Attestation sourceIdentityCertificate A digital identity certificate associated with the attestation source. string
VerificationResult_Attestation _sourceIdentityCertificate Extensions for sourceIdentityCertificate Element
VerificationResult_Attestation proxyIdentityCertificate A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source. string
VerificationResult_Attestation _proxyIdentityCertificate Extensions for proxyIdentityCertificate Element
VerificationResult_Attestation proxySignature Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source. Signature
VerificationResult_Attestation sourceSignature Signed assertion by the attestation source that they have attested to the information. Signature
VerificationResult_PrimarySource id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
VerificationResult_PrimarySource extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
VerificationResult_PrimarySource modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
VerificationResult_PrimarySource who Reference to the primary source. Reference
VerificationResult_PrimarySource type Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source). CodeableConcept
VerificationResult_PrimarySource communicationMethod Method for communicating with the primary source (manual; API; Push). CodeableConcept
VerificationResult_PrimarySource validationStatus Status of the validation of the target against the primary source (successful; failed; unknown). CodeableConcept
VerificationResult_PrimarySource validationDate When the target was validated against the primary source. dateTime
VerificationResult_PrimarySource _validationDate Extensions for validationDate Element
VerificationResult_PrimarySource canPushUpdates Ability of the primary source to push updates/alerts (yes; no; undetermined). CodeableConcept
VerificationResult_PrimarySource pushTypeAvailable Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source). CodeableConcept
VerificationResult_Validator id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
VerificationResult_Validator extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
VerificationResult_Validator modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
VerificationResult_Validator organization Reference to the organization validating information. Reference
VerificationResult_Validator identityCertificate A digital identity certificate associated with the validator. string
VerificationResult_Validator _identityCertificate Extensions for identityCertificate Element
VerificationResult_Validator attestationSignature Signed assertion by the validator that they have validated the information. Signature
VisionPrescription resourceType This is a VisionPrescription resource VisionPrescription
VisionPrescription id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. id
VisionPrescription meta 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. Meta
VisionPrescription implicitRules 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. uri
VisionPrescription _implicitRules Extensions for implicitRules Element
VisionPrescription language The base language in which the resource is written. code
VisionPrescription _language Extensions for language Element
VisionPrescription text 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. Narrative
VisionPrescription contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. ResourceList
VisionPrescription extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
VisionPrescription modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
VisionPrescription identifier A unique identifier assigned to this vision prescription. Identifier
VisionPrescription status The status of the resource instance. code
VisionPrescription _status Extensions for status Element
VisionPrescription created The date this resource was created. dateTime
VisionPrescription _created Extensions for created Element
VisionPrescription patient A resource reference to the person to whom the vision prescription applies. Reference
VisionPrescription encounter A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued. Reference
VisionPrescription dateWritten The date (and perhaps time) when the prescription was written. dateTime
VisionPrescription _dateWritten Extensions for dateWritten Element
VisionPrescription prescriber The healthcare professional responsible for authorizing the prescription. Reference
VisionPrescription lensSpecification Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals. VisionPrescription_LensSpecification
VisionPrescription_LensSpecification id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
VisionPrescription_LensSpecification extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
VisionPrescription_LensSpecification modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
VisionPrescription_LensSpecification product Identifies the type of vision correction product which is required for the patient. CodeableConcept
VisionPrescription_LensSpecification eye The eye for which the lens specification applies. enum values:
right
left
VisionPrescription_LensSpecification _eye Extensions for eye Element
VisionPrescription_LensSpecification sphere Lens power measured in dioptres (0.25 units). decimal
VisionPrescription_LensSpecification _sphere Extensions for sphere Element
VisionPrescription_LensSpecification cylinder Power adjustment for astigmatism measured in dioptres (0.25 units). decimal
VisionPrescription_LensSpecification _cylinder Extensions for cylinder Element
VisionPrescription_LensSpecification axis Adjustment for astigmatism measured in integer degrees. integer
VisionPrescription_LensSpecification _axis Extensions for axis Element
VisionPrescription_LensSpecification prism Allows for adjustment on two axis. VisionPrescription_Prism
VisionPrescription_LensSpecification add Power adjustment for multifocal lenses measured in dioptres (0.25 units). decimal
VisionPrescription_LensSpecification _add Extensions for add Element
VisionPrescription_LensSpecification power Contact lens power measured in dioptres (0.25 units). decimal
VisionPrescription_LensSpecification _power Extensions for power Element
VisionPrescription_LensSpecification backCurve Back curvature measured in millimetres. decimal
VisionPrescription_LensSpecification _backCurve Extensions for backCurve Element
VisionPrescription_LensSpecification diameter Contact lens diameter measured in millimetres. decimal
VisionPrescription_LensSpecification _diameter Extensions for diameter Element
VisionPrescription_LensSpecification duration The recommended maximum wear period for the lens. Quantity
VisionPrescription_LensSpecification color Special color or pattern. string
VisionPrescription_LensSpecification _color Extensions for color Element
VisionPrescription_LensSpecification brand Brand recommendations or restrictions. string
VisionPrescription_LensSpecification _brand Extensions for brand Element
VisionPrescription_LensSpecification note Notes for special requirements such as coatings and lens materials. Annotation
VisionPrescription_Prism id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string
VisionPrescription_Prism extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Extension
VisionPrescription_Prism modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Extension
VisionPrescription_Prism amount Amount of prism to compensate for eye alignment in fractional units. decimal
VisionPrescription_Prism _amount Extensions for amount Element
VisionPrescription_Prism base The relative base, or reference lens edge, for the prism. enum values:
up
down
in
out
VisionPrescription_Prism _base Extensions for base Element