FHIR© Data Dictionary[R5 v4.4.0]  last update: 05.30.20 C W Global Consulting, LLC
The Healthcare Interterchange sm
🔍
🔍
🔍

ObjectNameFieldName DescriptionReference
AccountresourceTypeThis is a Account resourceAccount
AccountidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
AccountmetaThe metadata about the resource. 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
AccountimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
AccountlanguageThe base language in which the resource is written.code
Account_languageExtensions for languageElement
AccounttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
AccountcontainedThese 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
AccountextensionMay be 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
AccountmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
AccountidentifierUnique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).Identifier
AccountstatusIndicates whether the account is presently used/usable or not.enum values:
active
inactive
entered-in-error
on-hold
unknown
Account_statusExtensions for statusElement
AccounttypeCategorizes the account for reporting and searching purposes.CodeableConcept
AccountnameName used for the account when displaying it to humans in reports, etc.string
Account_nameExtensions for nameElement
AccountsubjectIdentifies 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
AccountservicePeriodThe date range of services associated with this account.Period
AccountcoverageThe party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.Account_Coverage
AccountownerIndicates the service area, hospital, department, etc. with responsibility for managing the Account.Reference
AccountdescriptionProvides additional information about what the account tracks and how it is used.string
Account_descriptionExtensions for descriptionElement
AccountguarantorThe parties responsible for balancing the account if other payment options fall short.Account_Guarantor
AccountpartOfReference to a parent Account.Reference
Account_CoverageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Account_CoverageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CoveragemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CoveragecoverageThe 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_CoveragepriorityThe priority of the coverage in the context of this account.positiveInt
Account_Coverage_priorityExtensions for priorityElement
Account_GuarantoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Account_GuarantorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GuarantormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GuarantorpartyThe entity who is responsible.Reference
Account_GuarantoronHoldA guarantor may be placed on credit hold or otherwise have their role temporarily suspended.boolean
Account_Guarantor_onHoldExtensions for onHoldElement
Account_GuarantorperiodThe timeframe during which the guarantor accepts responsibility for the account.Period
ActivityDefinitionresourceTypeThis is a ActivityDefinition resourceActivityDefinition
ActivityDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ActivityDefinitionmetaThe metadata about the resource. 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
ActivityDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ActivityDefinitionlanguageThe base language in which the resource is written.code
ActivityDefinition_languageExtensions for languageElement
ActivityDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ActivityDefinitioncontainedThese 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
ActivityDefinitionextensionMay be 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
ActivityDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ActivityDefinitionurlAn 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_urlExtensions for urlElement
ActivityDefinitionidentifierA 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
ActivityDefinitionversionThe 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_versionExtensions for versionElement
ActivityDefinitionnameA 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_nameExtensions for nameElement
ActivityDefinitiontitleA short, descriptive, user-friendly title for the activity definition.string
ActivityDefinition_titleExtensions for titleElement
ActivityDefinitionstatusThe status of this activity definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
ActivityDefinition_statusExtensions for statusElement
ActivityDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
ActivityDefinitiondateThe 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_dateExtensions for dateElement
ActivityDefinitionpublisherThe name of the organization or individual that published the activity definition.string
ActivityDefinition_publisherExtensions for publisherElement
ActivityDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ActivityDefinitiondescriptionA free text natural language description of the activity definition from a consumer's perspective.markdown
ActivityDefinition_descriptionExtensions for descriptionElement
ActivityDefinitionuseContextThe 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
ActivityDefinitionjurisdictionA legal or geographic region in which the activity definition is intended to be used.CodeableConcept
ActivityDefinitionpurposeExplanation of why this activity definition is needed and why it has been designed as it has.markdown
ActivityDefinition_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
ActivityDefinitionapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
ActivityDefinition_approvalDateExtensions for approvalDateElement
ActivityDefinitionlastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
ActivityDefinition_lastReviewDateExtensions for lastReviewDateElement
ActivityDefinitioneffectivePeriodThe period during which the activity definition content was or is planned to be in active use.Period
ActivityDefinitionsubtitleAn explanatory or alternate title for the activity definition giving additional information about its content.string
ActivityDefinition_subtitleExtensions for subtitleElement
ActivityDefinitionsubjectCodeableConceptA code or group definition that describes the intended subject of the activity being defined.CodeableConcept
ActivityDefinitionsubjectReferenceA code or group definition that describes the intended subject of the activity being defined.Reference
ActivityDefinitionusageA detailed description of how the activity definition is used from a clinical perspective.string
ActivityDefinition_usageExtensions for usageElement
ActivityDefinitiontopicDescriptive 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
ActivityDefinitionauthorAn individiual or organization primarily involved in the creation and maintenance of the content.ContactDetail
ActivityDefinitioneditorAn individual or organization primarily responsible for internal coherence of the content.ContactDetail
ActivityDefinitionreviewerAn individual or organization primarily responsible for review of some aspect of the content.ContactDetail
ActivityDefinitionendorserAn individual or organization responsible for officially endorsing the content for use in some setting.ContactDetail
ActivityDefinitionrelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.RelatedArtifact
ActivityDefinitionlibraryA reference to a Library resource containing any formal logic used by the activity definition.canonical
ActivityDefinitionkindA 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_kindExtensions for kindElement
ActivityDefinitionprofileA profile to which the target of the activity definition is expected to conform.canonical
ActivityDefinitioncodeDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.CodeableConcept
ActivityDefinitionintentIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.code
ActivityDefinition_intentExtensions for intentElement
ActivityDefinitionpriorityIndicates how quickly the activity should be addressed with respect to other requests.code
ActivityDefinition_priorityExtensions for priorityElement
ActivityDefinitiondoNotPerformSet 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_doNotPerformExtensions for doNotPerformElement
ActivityDefinitiontimingTimingThe period, timing or frequency upon which the described activity is to occur.Timing
ActivityDefinitiontimingDateTimeThe period, timing or frequency upon which the described activity is to occur.notDefined
ActivityDefinition_timingDateTimeExtensions for timingDateTimeElement
ActivityDefinitiontimingAgeThe period, timing or frequency upon which the described activity is to occur.Age
ActivityDefinitiontimingPeriodThe period, timing or frequency upon which the described activity is to occur.Period
ActivityDefinitiontimingRangeThe period, timing or frequency upon which the described activity is to occur.Range
ActivityDefinitiontimingDurationThe period, timing or frequency upon which the described activity is to occur.Duration
ActivityDefinitionlocationIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.Reference
ActivityDefinitionparticipantIndicates who should participate in performing the action described.ActivityDefinition_Participant
ActivityDefinitionproductReferenceIdentifies the food, drug or other product being consumed or supplied in the activity.Reference
ActivityDefinitionproductCodeableConceptIdentifies the food, drug or other product being consumed or supplied in the activity.CodeableConcept
ActivityDefinitionquantityIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).Quantity
ActivityDefinitiondosageProvides detailed dosage instructions in the same way that they are described for MedicationRequest resources.Dosage
ActivityDefinitionbodySiteIndicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).CodeableConcept
ActivityDefinitionspecimenRequirementDefines specimen requirements for the action to be performed, such as required specimens for a lab test.Reference
ActivityDefinitionobservationRequirementDefines observation requirements for the action to be performed, such as body weight or surface area.Reference
ActivityDefinitionobservationResultRequirementDefines the observations that are expected to be produced by the action.Reference
ActivityDefinitiontransformA 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
ActivityDefinitiondynamicValueDynamic 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_DynamicValueidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ActivityDefinition_DynamicValueextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DynamicValuemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DynamicValuepathThe 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_pathExtensions for pathElement
ActivityDefinition_DynamicValueexpressionAn expression specifying the value of the customized element.Expression
ActivityDefinition_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ActivityDefinition_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipanttypeThe type of participant in the action.code
ActivityDefinition_Participant_typeExtensions for typeElement
ActivityDefinition_ParticipantroleThe role the participant should play in performing the described action.CodeableConcept
AddressidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AddressextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AddressuseThe purpose of this address.enum values:
home
work
temp
old
billing
Address_useExtensions for useElement
AddresstypeDistinguishes 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_typeExtensions for typeElement
AddresstextSpecifies 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_textExtensions for textElement
AddresslineThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.string
Address_lineExtensions for lineElement
AddresscityThe name of the city, town, suburb, village or other community or delivery center.string
Address_cityExtensions for cityElement
AddressdistrictThe name of the administrative area (county).string
Address_districtExtensions for districtElement
AddressstateSub-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_stateExtensions for stateElement
AddresspostalCodeA postal code designating a region defined by the postal service.string
Address_postalCodeExtensions for postalCodeElement
AddresscountryCountry - a nation as commonly understood or generally accepted.string
Address_countryExtensions for countryElement
AddressperiodTime period when address was/is in use.Period
AdministrableProductDefinitionresourceTypeThis is a AdministrableProductDefinition resourceAdministrableProductDefinition
AdministrableProductDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
AdministrableProductDefinitionmetaThe metadata about the resource. 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
AdministrableProductDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
AdministrableProductDefinition_implicitRulesExtensions for implicitRulesElement
AdministrableProductDefinitionlanguageThe base language in which the resource is written.code
AdministrableProductDefinition_languageExtensions for languageElement
AdministrableProductDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
AdministrableProductDefinitioncontainedThese 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
AdministrableProductDefinitionextensionMay be 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
AdministrableProductDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
AdministrableProductDefinitionidentifierAn identifier for the pharmaceutical medicinal product.Identifier
AdministrableProductDefinitionsubjectThe product that this is a pharmaceutical product of.Reference
AdministrableProductDefinitionadministrableDoseFormThe administrable dose form, after necessary reconstitution.CodeableConcept
AdministrableProductDefinitionunitOfPresentationTodo.CodeableConcept
AdministrableProductDefinitionproducedFromThe manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients.Reference
AdministrableProductDefinitioningredientThe ingredients of this administrable pharmaceutical product.Reference
AdministrableProductDefinitiondeviceAccompanying device.Reference
AdministrableProductDefinitionpropertyCharacteristics e.g. a products onset of action.AdministrableProductDefinition_Property
AdministrableProductDefinitionrouteOfAdministrationThe path by which the pharmaceutical product is taken into or makes contact with the body.AdministrableProductDefinition_RouteOfAdministration
AdministrableProductDefinition_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdministrableProductDefinition_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AdministrableProductDefinition_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
AdministrableProductDefinition_PropertytypeA code expressing the type of characteristic.CodeableConcept
AdministrableProductDefinition_PropertyvalueCodeableConceptA value for the characteristic.CodeableConcept
AdministrableProductDefinition_PropertyvalueQuantityA value for the characteristic.Quantity
AdministrableProductDefinition_PropertyvalueDateA value for the characteristic.notDefined
AdministrableProductDefinition_Property_valueDateExtensions for valueDateElement
AdministrableProductDefinition_PropertyvalueBooleanA value for the characteristic.notDefined
AdministrableProductDefinition_Property_valueBooleanExtensions for valueBooleanElement
AdministrableProductDefinition_PropertyvalueAttachmentA value for the characteristic.Attachment
AdministrableProductDefinition_PropertystatusThe status of characteristic e.g. assigned or pending.CodeableConcept
AdministrableProductDefinition_RouteOfAdministrationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdministrableProductDefinition_RouteOfAdministrationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AdministrableProductDefinition_RouteOfAdministrationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
AdministrableProductDefinition_RouteOfAdministrationcodeCoded expression for the route.CodeableConcept
AdministrableProductDefinition_RouteOfAdministrationfirstDoseThe 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
AdministrableProductDefinition_RouteOfAdministrationmaxSingleDoseThe 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
AdministrableProductDefinition_RouteOfAdministrationmaxDosePerDayThe 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
AdministrableProductDefinition_RouteOfAdministrationmaxDosePerTreatmentPeriodThe maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.Ratio
AdministrableProductDefinition_RouteOfAdministrationmaxTreatmentPeriodThe maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.Duration
AdministrableProductDefinition_RouteOfAdministrationtargetSpeciesA species for which this route applies.AdministrableProductDefinition_TargetSpecies
AdministrableProductDefinition_TargetSpeciesidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdministrableProductDefinition_TargetSpeciesextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AdministrableProductDefinition_TargetSpeciesmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
AdministrableProductDefinition_TargetSpeciescodeCoded expression for the species.CodeableConcept
AdministrableProductDefinition_TargetSpecieswithdrawalPeriodA species specific time during which consumption of animal product is not appropriate.AdministrableProductDefinition_WithdrawalPeriod
AdministrableProductDefinition_WithdrawalPeriodidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdministrableProductDefinition_WithdrawalPeriodextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AdministrableProductDefinition_WithdrawalPeriodmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
AdministrableProductDefinition_WithdrawalPeriodtissueCoded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.CodeableConcept
AdministrableProductDefinition_WithdrawalPeriodvalueA value for the time.Quantity
AdministrableProductDefinition_WithdrawalPeriodsupportingInformationExtra information about the withdrawal period.string
AdministrableProductDefinition_WithdrawalPeriod_supportingInformationExtensions for supportingInformationElement
AdverseEventresourceTypeThis is a AdverseEvent resourceAdverseEvent
AdverseEventidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
AdverseEventmetaThe metadata about the resource. 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
AdverseEventimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
AdverseEventlanguageThe base language in which the resource is written.code
AdverseEvent_languageExtensions for languageElement
AdverseEventtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
AdverseEventcontainedThese 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
AdverseEventextensionMay be 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
AdverseEventmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
AdverseEventidentifierBusiness 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
AdverseEventstatusThe current state of the adverse event or potential adverse event.code
AdverseEvent_statusExtensions for statusElement
AdverseEventactualityWhether 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_actualityExtensions for actualityElement
AdverseEventcategoryThe overall type of event, intended for search and filtering purposes.CodeableConcept
AdverseEventcodeSpecific event that occurred or that was averted, such as patient fall, wrong organ removed, or wrong blood transfused.CodeableConcept
AdverseEventsubjectThis subject or group impacted by the event.Reference
AdverseEventencounterThe Encounter associated with the start of the AdverseEvent.Reference
AdverseEventoccurrenceDateTimeThe date (and perhaps time) when the adverse event occurred.notDefined
AdverseEvent_occurrenceDateTimeExtensions for occurrenceDateTimeElement
AdverseEventoccurrencePeriodThe date (and perhaps time) when the adverse event occurred.Period
AdverseEventoccurrenceTimingThe date (and perhaps time) when the adverse event occurred.Timing
AdverseEventdetectedEstimated or actual date the AdverseEvent began, in the opinion of the reporter.dateTime
AdverseEvent_detectedExtensions for detectedElement
AdverseEventrecordedDateThe date on which the existence of the AdverseEvent was first recorded.dateTime
AdverseEvent_recordedDateExtensions for recordedDateElement
AdverseEventresultingConditionIncludes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).Reference
AdverseEventlocationThe information about where the adverse event occurred.Reference
AdverseEventseriousnessAssessment whether this event, or averted event, was of clinical importance.CodeableConcept
AdverseEventoutcomeDescribes the type of outcome from the adverse event, such as resolved, recovering, ongoing, resolved-with-sequelae, or fatal.CodeableConcept
AdverseEventrecorderInformation on who recorded the adverse event. May be the patient or a practitioner.Reference
AdverseEventparticipantIndicates who or what participated in the adverse event and how they were involved.AdverseEvent_Participant
AdverseEventsuspectEntityDescribes the entity that is suspected to have caused the adverse event.AdverseEvent_SuspectEntity
AdverseEventcontributingFactorThe contributing factors suspected to have increased the probability or severity of the adverse event.AdverseEvent_ContributingFactor
AdverseEventpreventiveActionPreventive actions that contributed to avoiding the adverse event.AdverseEvent_PreventiveAction
AdverseEventmitigatingActionThe ameliorating action taken after the adverse event occured in order to reduce the extent of harm.AdverseEvent_MitigatingAction
AdverseEventsupportingInfoSupporting information relevant to the event.AdverseEvent_SupportingInfo
AdverseEventstudyThe research study that the subject is enrolled in.Reference
AdverseEvent_CausalityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdverseEvent_CausalityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CausalitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CausalityassessmentMethodThe method of evaluating the relatedness of the suspected entity to the event.CodeableConcept
AdverseEvent_CausalityentityRelatednessThe result of the assessment regarding the relatedness of the suspected entity to the event.CodeableConcept
AdverseEvent_CausalityauthorThe author of the information on the possible cause of the event.Reference
AdverseEvent_ContributingFactoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdverseEvent_ContributingFactorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContributingFactormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContributingFactoritemReferenceThe item that is suspected to have increased the probability or severity of the adverse event.Reference
AdverseEvent_ContributingFactoritemCodeableConceptThe item that is suspected to have increased the probability or severity of the adverse event.CodeableConcept
AdverseEvent_MitigatingActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdverseEvent_MitigatingActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MitigatingActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MitigatingActionitemReferenceThe ameliorating action taken after the adverse event occured in order to reduce the extent of harm.Reference
AdverseEvent_MitigatingActionitemCodeableConceptThe ameliorating action taken after the adverse event occured in order to reduce the extent of harm.CodeableConcept
AdverseEvent_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdverseEvent_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipantfunctionDistinguishes the type of involvement of the actor in the adverse event, such as contributor or informant.CodeableConcept
AdverseEvent_ParticipantactorIndicates who or what participated in the event.Reference
AdverseEvent_PreventiveActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdverseEvent_PreventiveActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PreventiveActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PreventiveActionitemReferenceThe action that contributed to avoiding the adverse event.Reference
AdverseEvent_PreventiveActionitemCodeableConceptThe action that contributed to avoiding the adverse event.CodeableConcept
AdverseEvent_SupportingInfoidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdverseEvent_SupportingInfoextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SupportingInfomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SupportingInfoitemReferenceRelevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action.Reference
AdverseEvent_SupportingInfoitemCodeableConceptRelevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action.CodeableConcept
AdverseEvent_SuspectEntityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AdverseEvent_SuspectEntityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SuspectEntitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SuspectEntityinstanceCodeableConceptIdentifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.CodeableConcept
AdverseEvent_SuspectEntityinstanceReferenceIdentifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.Reference
AdverseEvent_SuspectEntitycausalityInformation on the possible cause of the event.AdverseEvent_Causality
AgeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AgeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AgevalueThe value of the measured amount. The value includes an implicit precision in the presentation of the value.decimal
Age_valueExtensions for valueElement
AgecomparatorHow 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_comparatorExtensions for comparatorElement
AgeunitA human-readable form of the unit.string
Age_unitExtensions for unitElement
AgesystemThe identification of the system that provides the coded form of the unit.uri
Age_systemExtensions for systemElement
AgecodeA computer processable form of the unit in some unit representation system.code
Age_codeExtensions for codeElement
AllergyIntoleranceresourceTypeThis is a AllergyIntolerance resourceAllergyIntolerance
AllergyIntoleranceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
AllergyIntolerancemetaThe metadata about the resource. 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
AllergyIntoleranceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
AllergyIntolerancelanguageThe base language in which the resource is written.code
AllergyIntolerance_languageExtensions for languageElement
AllergyIntolerancetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
AllergyIntolerancecontainedThese 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
AllergyIntoleranceextensionMay be 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
AllergyIntolerancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
AllergyIntoleranceidentifierBusiness 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
AllergyIntoleranceclinicalStatusThe clinical status of the allergy or intolerance.CodeableConcept
AllergyIntoleranceverificationStatusAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).CodeableConcept
AllergyIntolerancetypeIdentification of the underlying physiological mechanism for the reaction risk.enum values:
allergy
intolerance
AllergyIntolerance_typeExtensions for typeElement
AllergyIntolerancecategoryCategory of the identified substance.enum values:
food
medication
environment
biologic
AllergyIntolerance_categoryExtensions for categoryElement
AllergyIntolerancecriticalityEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.enum values:
low
high
unable-to-assess
AllergyIntolerance_criticalityExtensions for criticalityElement
AllergyIntolerancecodeCode 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
AllergyIntolerancepatientThe patient who has the allergy or intolerance.Reference
AllergyIntoleranceencounterThe encounter when the allergy or intolerance was asserted.Reference
AllergyIntoleranceonsetDateTimeEstimated or actual date, date-time, or age when allergy or intolerance was identified.notDefined
AllergyIntolerance_onsetDateTimeExtensions for onsetDateTimeElement
AllergyIntoleranceonsetAgeEstimated or actual date, date-time, or age when allergy or intolerance was identified.Age
AllergyIntoleranceonsetPeriodEstimated or actual date, date-time, or age when allergy or intolerance was identified.Period
AllergyIntoleranceonsetRangeEstimated or actual date, date-time, or age when allergy or intolerance was identified.Range
AllergyIntoleranceonsetStringEstimated or actual date, date-time, or age when allergy or intolerance was identified.notDefined
AllergyIntolerance_onsetStringExtensions for onsetStringElement
AllergyIntolerancerecordedDateThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.dateTime
AllergyIntolerance_recordedDateExtensions for recordedDateElement
AllergyIntolerancerecorderIndividual who recorded the record and takes responsibility for its content.Reference
AllergyIntoleranceasserterThe source of the information about the allergy that is recorded.Reference
AllergyIntolerancelastOccurrenceRepresents the date and/or time of the last known occurrence of a reaction event.dateTime
AllergyIntolerance_lastOccurrenceExtensions for lastOccurrenceElement
AllergyIntolerancenoteAdditional narrative about the propensity for the Adverse Reaction, not captured in other fields.Annotation
AllergyIntolerancereactionDetails about each adverse reaction event linked to exposure to the identified substance.AllergyIntolerance_Reaction
AllergyIntolerance_ReactionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AllergyIntolerance_ReactionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ReactionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ReactionsubstanceIdentification 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_ReactionmanifestationClinical symptoms and/or signs that are observed or associated with the adverse reaction event.CodeableConcept
AllergyIntolerance_ReactiondescriptionText description about the reaction as a whole, including details of the manifestation if required.string
AllergyIntolerance_Reaction_descriptionExtensions for descriptionElement
AllergyIntolerance_ReactiononsetRecord of the date and/or time of the onset of the Reaction.dateTime
AllergyIntolerance_Reaction_onsetExtensions for onsetElement
AllergyIntolerance_ReactionseverityClinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.enum values:
mild
moderate
severe
AllergyIntolerance_Reaction_severityExtensions for severityElement
AllergyIntolerance_ReactionexposureRouteIdentification of the route by which the subject was exposed to the substance.CodeableConcept
AllergyIntolerance_ReactionnoteAdditional text about the adverse reaction event not captured in other fields.Annotation
AnnotationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AnnotationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AnnotationauthorReferenceThe individual responsible for making the annotation.Reference
AnnotationauthorStringThe individual responsible for making the annotation.notDefined
Annotation_authorStringExtensions for authorStringElement
AnnotationtimeIndicates when this particular annotation was made.dateTime
Annotation_timeExtensions for timeElement
AnnotationtextThe text of the annotation in markdown format.markdown
Annotation_textExtensions for textElement
AppointmentresourceTypeThis is a Appointment resourceAppointment
AppointmentidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
AppointmentmetaThe metadata about the resource. 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
AppointmentimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
AppointmentlanguageThe base language in which the resource is written.code
Appointment_languageExtensions for languageElement
AppointmenttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
AppointmentcontainedThese 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
AppointmentextensionMay be 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
AppointmentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
AppointmentidentifierThis 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
AppointmentstatusThe 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_statusExtensions for statusElement
AppointmentcancelationReasonThe 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
AppointmentserviceCategoryA broad categorization of the service that is to be performed during this appointment.CodeableConcept
AppointmentserviceTypeThe specific service that is to be performed during this appointment.CodeableConcept
AppointmentspecialtyThe specialty of a practitioner that would be required to perform the service requested in this appointment.CodeableConcept
AppointmentappointmentTypeThe style of appointment or patient that has been booked in the slot (not service type).CodeableConcept
AppointmentreasonThe reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.CodeableReference
AppointmentpriorityThe 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_priorityExtensions for priorityElement
AppointmentdescriptionThe 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_descriptionExtensions for descriptionElement
AppointmentsupportingInformationAdditional information to support the appointment provided when making the appointment.Reference
AppointmentstartDate/Time that the appointment is to take place.instant
Appointment_startExtensions for startElement
AppointmentendDate/Time that the appointment is to conclude.instant
Appointment_endExtensions for endElement
AppointmentminutesDurationNumber 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_minutesDurationExtensions for minutesDurationElement
AppointmentslotThe slots from the participants' schedules that will be filled by the appointment.Reference
AppointmentcreatedThe 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_createdExtensions for createdElement
AppointmentcommentAdditional comments about the appointment.string
Appointment_commentExtensions for commentElement
AppointmentpatientInstructionWhile 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_patientInstructionExtensions for patientInstructionElement
AppointmentbasedOnThe service request this appointment is allocated to assess (e.g. incoming referral or procedure request).Reference
AppointmentparticipantList of participants involved in the appointment.Appointment_Participant
AppointmentrequestedPeriodA 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
AppointmentResponseresourceTypeThis is a AppointmentResponse resourceAppointmentResponse
AppointmentResponseidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
AppointmentResponsemetaThe metadata about the resource. 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
AppointmentResponseimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
AppointmentResponselanguageThe base language in which the resource is written.code
AppointmentResponse_languageExtensions for languageElement
AppointmentResponsetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
AppointmentResponsecontainedThese 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
AppointmentResponseextensionMay be 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
AppointmentResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
AppointmentResponseidentifierThis 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
AppointmentResponseappointmentAppointment that this response is replying to.Reference
AppointmentResponsestartDate/Time that the appointment is to take place, or requested new start time.instant
AppointmentResponse_startExtensions for startElement
AppointmentResponseendThis 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_endExtensions for endElement
AppointmentResponseparticipantTypeRole of participant in the appointment.CodeableConcept
AppointmentResponseactorA Person, Location, HealthcareService, or Device that is participating in the appointment.Reference
AppointmentResponseparticipantStatusParticipation 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_participantStatusExtensions for participantStatusElement
AppointmentResponsecommentAdditional comments about the appointment.string
AppointmentResponse_commentExtensions for commentElement
Appointment_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Appointment_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipanttypeRole of participant in the appointment.CodeableConcept
Appointment_ParticipantactorA Person, Location/HealthcareService or Device that is participating in the appointment.Reference
Appointment_ParticipantrequiredWhether 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_requiredExtensions for requiredElement
Appointment_ParticipantstatusParticipation status of the actor.enum values:
accepted
declined
tentative
needs-action
Appointment_Participant_statusExtensions for statusElement
Appointment_ParticipantperiodParticipation period of the actor.Period
AttachmentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AttachmentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
AttachmentcontentTypeIdentifies 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_contentTypeExtensions for contentTypeElement
AttachmentlanguageThe human language of the content. The value can be any valid value according to BCP 47.code
Attachment_languageExtensions for languageElement
AttachmentdataThe actual data of the attachment - a sequence of bytes, base64 encoded.base64Binary
Attachment_dataExtensions for dataElement
AttachmenturlA location where the data can be accessed.url
Attachment_urlExtensions for urlElement
AttachmentsizeThe number of bytes of data that make up this attachment (before base64 encoding, if that is done).integer64
Attachment_sizeExtensions for sizeElement
AttachmenthashThe calculated hash of the data using SHA-1. Represented using base64.base64Binary
Attachment_hashExtensions for hashElement
AttachmenttitleA label or set of text to display in place of the data.string
Attachment_titleExtensions for titleElement
AttachmentcreationThe date that the attachment was first created.dateTime
Attachment_creationExtensions for creationElement
AttachmentheightHeight of the image in pixels (photo/video).positiveInt
Attachment_heightExtensions for heightElement
AttachmentwidthWidth of the image in pixels (photo/video).positiveInt
Attachment_widthExtensions for widthElement
AttachmentframesThe 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
Attachment_framesExtensions for framesElement
AttachmentdurationThe duration of the recording in seconds - for audio and video.decimal
Attachment_durationExtensions for durationElement
AttachmentpagesThe number of pages when printed.positiveInt
Attachment_pagesExtensions for pagesElement
AuditEventresourceTypeThis is a AuditEvent resourceAuditEvent
AuditEventidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
AuditEventmetaThe metadata about the resource. 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
AuditEventimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
AuditEventlanguageThe base language in which the resource is written.code
AuditEvent_languageExtensions for languageElement
AuditEventtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
AuditEventcontainedThese 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
AuditEventextensionMay be 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
AuditEventmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
AuditEventtypeIdentifier 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
AuditEventsubtypeIdentifier for the category of event.Coding
AuditEventactionIndicator for type of action performed during the event that generated the audit.enum values:
C
R
U
D
E
AuditEvent_actionExtensions for actionElement
AuditEventseverityIndicates and enables segmentation of various severity including debugging from critical.enum values:
Emergency
Alert
Critical
Error
Warning
Notice
Informational
Debug
AuditEvent_severityExtensions for severityElement
AuditEventperiodThe period during which the activity occurred.Period
AuditEventrecordedThe time when the event was recorded.instant
AuditEvent_recordedExtensions for recordedElement
AuditEventoutcomeIndicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.CodeableConcept
AuditEventpurposeOfEventThe purposeOfUse (reason) that was used during the event being recorded.CodeableConcept
AuditEventagentAn actor taking an active role in the event or activity that is logged.AuditEvent_Agent
AuditEventsourceThe system that is reporting the event.AuditEvent_Source
AuditEvententitySpecific instances of data or objects that have been accessed.AuditEvent_Entity
AuditEvent_AgentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AuditEvent_AgentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AgentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AgenttypeSpecification of the participation type the user plays when performing the event.CodeableConcept
AuditEvent_AgentroleThe 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_AgentwhoReference to who this agent is that was involved in the event.Reference
AuditEvent_AgentaltIdAlternative 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_altIdExtensions for altIdElement
AuditEvent_AgentnameHuman-meaningful name for the agent.string
AuditEvent_Agent_nameExtensions for nameElement
AuditEvent_AgentrequestorIndicator that the user is or is not the requestor, or initiator, for the event being audited.boolean
AuditEvent_Agent_requestorExtensions for requestorElement
AuditEvent_AgentlocationWhere the event occurred.Reference
AuditEvent_AgentpolicyThe 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_policyExtensions for policyElement
AuditEvent_AgentmediaType of media involved. Used when the event is about exporting/importing onto media.Coding
AuditEvent_AgentnetworkLogical network location for application activity, if the activity has a network location.AuditEvent_Network
AuditEvent_AgentpurposeOfUseThe reason (purpose of use), specific to this agent, that was used during the event being recorded.CodeableConcept
AuditEvent_DetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AuditEvent_DetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DetailtypeThe type of extra detail provided in the value.string
AuditEvent_Detail_typeExtensions for typeElement
AuditEvent_DetailvalueStringThe value of the extra detail.notDefined
AuditEvent_Detail_valueStringExtensions for valueStringElement
AuditEvent_DetailvalueBase64BinaryThe value of the extra detail.notDefined
AuditEvent_Detail_valueBase64BinaryExtensions for valueBase64BinaryElement
AuditEvent_EntityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AuditEvent_EntityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EntitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EntitywhatIdentifies a specific instance of the entity. The reference should be version specific.Reference
AuditEvent_EntitytypeThe type of the object that was involved in this audit event.Coding
AuditEvent_EntityroleCode representing the role the entity played in the event being audited.Coding
AuditEvent_EntitylifecycleIdentifier for the data life-cycle stage for the entity.Coding
AuditEvent_EntitysecurityLabelSecurity labels for the identified entity.Coding
AuditEvent_EntitynameA name of the entity in the audit event.string
AuditEvent_Entity_nameExtensions for nameElement
AuditEvent_EntityqueryThe query parameters for a query-type entities.base64Binary
AuditEvent_Entity_queryExtensions for queryElement
AuditEvent_EntitydetailTagged value pairs for conveying additional information about the entity.AuditEvent_Detail
AuditEvent_NetworkidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AuditEvent_NetworkextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_NetworkmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_NetworkaddressAn identifier for the network access point of the user device for the audit event.string
AuditEvent_Network_addressExtensions for addressElement
AuditEvent_NetworktypeAn identifier for the type of network access point that originated the audit event.enum values:
1
2
3
4
5
AuditEvent_Network_typeExtensions for typeElement
AuditEvent_SourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
AuditEvent_SourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SourcesiteLogical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.string
AuditEvent_Source_siteExtensions for siteElement
AuditEvent_SourceobserverIdentifier of the source where the event was detected.Reference
AuditEvent_SourcetypeCode specifying the type of source where event originated.Coding
BackboneTypeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
BackboneTypeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
BackboneTypemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
BasicresourceTypeThis is a Basic resourceBasic
BasicidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
BasicmetaThe metadata about the resource. 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
BasicimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
BasiclanguageThe base language in which the resource is written.code
Basic_languageExtensions for languageElement
BasictextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
BasiccontainedThese 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
BasicextensionMay be 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
BasicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
BasicidentifierIdentifier assigned to the resource for business purposes, outside the context of FHIR.Identifier
BasiccodeIdentifies the 'type' of resource - equivalent to the resource name for other resources.CodeableConcept
BasicsubjectIdentifies the patient, practitioner, device or any other resource that is the "focus" of this resource.Reference
BasiccreatedIdentifies when the resource was first created.date
Basic_createdExtensions for createdElement
BasicauthorIndicates who was responsible for creating the resource instance.Reference
BinaryresourceTypeThis is a Binary resourceBinary
BinaryidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
BinarymetaThe metadata about the resource. 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
BinaryimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
BinarylanguageThe base language in which the resource is written.code
Binary_languageExtensions for languageElement
BinarycontentTypeMimeType of the binary content represented as a standard MimeType (BCP 13).code
Binary_contentTypeExtensions for contentTypeElement
BinarysecurityContextThis element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.Reference
BinarydataThe actual content, base64 encoded.base64Binary
Binary_dataExtensions for dataElement
BiologicallyDerivedProductresourceTypeThis is a BiologicallyDerivedProduct resourceBiologicallyDerivedProduct
BiologicallyDerivedProductidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
BiologicallyDerivedProductmetaThe metadata about the resource. 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
BiologicallyDerivedProductimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
BiologicallyDerivedProductlanguageThe base language in which the resource is written.code
BiologicallyDerivedProduct_languageExtensions for languageElement
BiologicallyDerivedProducttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
BiologicallyDerivedProductcontainedThese 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
BiologicallyDerivedProductextensionMay be 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
BiologicallyDerivedProductmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
BiologicallyDerivedProductidentifierThis 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
BiologicallyDerivedProductproductCategoryBroad category of this product.enum values:
organ
tissue
fluid
cells
biologicalAgent
BiologicallyDerivedProduct_productCategoryExtensions for productCategoryElement
BiologicallyDerivedProductproductCodeA code that identifies the kind of this biologically derived product (SNOMED Ctcode).CodeableConcept
BiologicallyDerivedProductstatusWhether the product is currently available.enum values:
available
unavailable
BiologicallyDerivedProduct_statusExtensions for statusElement
BiologicallyDerivedProductrequestProcedure request to obtain this biologically derived product.Reference
BiologicallyDerivedProductquantityNumber of discrete units within this product.integer
BiologicallyDerivedProduct_quantityExtensions for quantityElement
BiologicallyDerivedProductparentParent product (if any).Reference
BiologicallyDerivedProductcollectionHow this product was collected.BiologicallyDerivedProduct_Collection
BiologicallyDerivedProductprocessingAny 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
BiologicallyDerivedProductmanipulationAny 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
BiologicallyDerivedProductstorageProduct storage.BiologicallyDerivedProduct_Storage
BiologicallyDerivedProduct_CollectionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
BiologicallyDerivedProduct_CollectionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CollectionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CollectioncollectorHealthcare professional who is performing the collection.Reference
BiologicallyDerivedProduct_CollectionsourceThe patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.Reference
BiologicallyDerivedProduct_CollectioncollectedDateTimeTime of product collection.notDefined
BiologicallyDerivedProduct_Collection_collectedDateTimeExtensions for collectedDateTimeElement
BiologicallyDerivedProduct_CollectioncollectedPeriodTime of product collection.Period
BiologicallyDerivedProduct_ManipulationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
BiologicallyDerivedProduct_ManipulationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ManipulationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ManipulationdescriptionDescription of manipulation.string
BiologicallyDerivedProduct_Manipulation_descriptionExtensions for descriptionElement
BiologicallyDerivedProduct_ManipulationtimeDateTimeTime of manipulation.notDefined
BiologicallyDerivedProduct_Manipulation_timeDateTimeExtensions for timeDateTimeElement
BiologicallyDerivedProduct_ManipulationtimePeriodTime of manipulation.Period
BiologicallyDerivedProduct_ProcessingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
BiologicallyDerivedProduct_ProcessingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProcessingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcessingdescriptionDescription of of processing.string
BiologicallyDerivedProduct_Processing_descriptionExtensions for descriptionElement
BiologicallyDerivedProduct_ProcessingprocedureProcesing code.CodeableConcept
BiologicallyDerivedProduct_ProcessingadditiveSubstance added during processing.Reference
BiologicallyDerivedProduct_ProcessingtimeDateTimeTime of processing.notDefined
BiologicallyDerivedProduct_Processing_timeDateTimeExtensions for timeDateTimeElement
BiologicallyDerivedProduct_ProcessingtimePeriodTime of processing.Period
BiologicallyDerivedProduct_StorageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
BiologicallyDerivedProduct_StorageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StoragemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StoragedescriptionDescription of storage.string
BiologicallyDerivedProduct_Storage_descriptionExtensions for descriptionElement
BiologicallyDerivedProduct_StoragetemperatureStorage temperature.decimal
BiologicallyDerivedProduct_Storage_temperatureExtensions for temperatureElement
BiologicallyDerivedProduct_StoragescaleTemperature scale used.enum values:
farenheit
celsius
kelvin
BiologicallyDerivedProduct_Storage_scaleExtensions for scaleElement
BiologicallyDerivedProduct_StoragedurationStorage timeperiod.Period
BodyStructureresourceTypeThis is a BodyStructure resourceBodyStructure
BodyStructureidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
BodyStructuremetaThe metadata about the resource. 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
BodyStructureimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
BodyStructurelanguageThe base language in which the resource is written.code
BodyStructure_languageExtensions for languageElement
BodyStructuretextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
BodyStructurecontainedThese 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
BodyStructureextensionMay be 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
BodyStructuremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
BodyStructureidentifierIdentifier for this instance of the anatomical structure.Identifier
BodyStructureactiveWhether this body site is in active use.boolean
BodyStructure_activeExtensions for activeElement
BodyStructuremorphologyThe kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.CodeableConcept
BodyStructurelocationThe anatomical location or region of the specimen, lesion, or body structure.CodeableConcept
BodyStructurelocationQualifierQualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.CodeableConcept
BodyStructuredescriptionA summary, characterization or explanation of the body structure.string
BodyStructure_descriptionExtensions for descriptionElement
BodyStructureimageImage or images used to identify a location.Attachment
BodyStructurepatientThe person to which the body site belongs.Reference
BundleresourceTypeThis is a Bundle resourceBundle
BundleidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
BundlemetaThe metadata about the resource. 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
BundleimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
BundlelanguageThe base language in which the resource is written.code
Bundle_languageExtensions for languageElement
BundleidentifierA persistent identifier for the bundle that won't change as a bundle is copied from server to server.Identifier
BundletypeIndicates 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
subscription-notification
Bundle_typeExtensions for typeElement
BundletimestampThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.instant
Bundle_timestampExtensions for timestampElement
BundletotalIf 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_totalExtensions for totalElement
linkA series of links that provide context to this bundle.Bundle_Link
BundleentryAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).Bundle_Entry
BundlesignatureDigital Signature - base64 encoded. XML-DSig or a JWT.Signature
Bundle_EntryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Bundle_EntryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EntrymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EntrylinkA series of links that provide context to this entry.Bundle_Link
Bundle_EntryfullUrlThe 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_fullUrlExtensions for fullUrlElement
Bundle_EntryresourceThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.ResourceList
Bundle_EntrysearchInformation about the search process that lead to the creation of this entry.Bundle_Search
Bundle_EntryrequestAdditional 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_EntryresponseIndicates 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
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
relationA 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
_relationExtensions for relationElement
urlThe reference details for the link.uri
_urlExtensions for urlElement
Bundle_RequestidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Bundle_RequestextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RequestmethodIn 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_methodExtensions for methodElement
Bundle_RequesturlThe URL for this entry, relative to the root (the address to which the request is posted).uri
Bundle_Request_urlExtensions for urlElement
Bundle_RequestifNoneMatchIf the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).string
Bundle_Request_ifNoneMatchExtensions for ifNoneMatchElement
Bundle_RequestifModifiedSinceOnly perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).instant
Bundle_Request_ifModifiedSinceExtensions for ifModifiedSinceElement
Bundle_RequestifMatchOnly perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).string
Bundle_Request_ifMatchExtensions for ifMatchElement
Bundle_RequestifNoneExistInstruct 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_ifNoneExistExtensions for ifNoneExistElement
Bundle_ResponseidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Bundle_ResponseextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ResponsestatusThe 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_statusExtensions for statusElement
Bundle_ResponselocationThe location header created by processing this operation, populated if the operation returns a location.uri
Bundle_Response_locationExtensions for locationElement
Bundle_ResponseetagThe 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_etagExtensions for etagElement
Bundle_ResponselastModifiedThe date/time that the resource was modified on the server.instant
Bundle_Response_lastModifiedExtensions for lastModifiedElement
Bundle_ResponseoutcomeAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.ResourceList
Bundle_SearchidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Bundle_SearchextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SearchmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SearchmodeWhy 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_modeExtensions for modeElement
Bundle_SearchscoreWhen searching, the server's search ranking score for the entry.decimal
Bundle_Search_scoreExtensions for scoreElement
CapabilityStatementresourceTypeThis is a CapabilityStatement resourceCapabilityStatement
CapabilityStatementidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CapabilityStatementmetaThe metadata about the resource. 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
CapabilityStatementimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CapabilityStatementlanguageThe base language in which the resource is written.code
CapabilityStatement_languageExtensions for languageElement
CapabilityStatementtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CapabilityStatementcontainedThese 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
CapabilityStatementextensionMay be 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
CapabilityStatementmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CapabilityStatementurlAn 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_urlExtensions for urlElement
CapabilityStatementidentifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
CapabilityStatementversionThe 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_versionExtensions for versionElement
CapabilityStatementnameA 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_nameExtensions for nameElement
CapabilityStatementtitleA short, descriptive, user-friendly title for the capability statement.string
CapabilityStatement_titleExtensions for titleElement
CapabilityStatementstatusThe status of this capability statement. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
CapabilityStatement_statusExtensions for statusElement
CapabilityStatementexperimentalA 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_experimentalExtensions for experimentalElement
CapabilityStatementdateThe 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_dateExtensions for dateElement
CapabilityStatementpublisherThe name of the organization or individual that published the capability statement.string
CapabilityStatement_publisherExtensions for publisherElement
CapabilityStatementcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
CapabilityStatementdescriptionA 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_descriptionExtensions for descriptionElement
CapabilityStatementuseContextThe 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
CapabilityStatementjurisdictionA legal or geographic region in which the capability statement is intended to be used.CodeableConcept
CapabilityStatementpurposeExplanation of why this capability statement is needed and why it has been designed as it has.markdown
CapabilityStatement_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
CapabilityStatementkindThe 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_kindExtensions for kindElement
CapabilityStatementinstantiatesReference 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
CapabilityStatementimportsReference 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
CapabilityStatementsoftwareSoftware 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
CapabilityStatementimplementationIdentifies 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
CapabilityStatementfhirVersionThe 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.0.2
3.3.0
3.5.0
4.0.0
4.0.1
4.1.0
4.2.0
4.4.0
CapabilityStatement_fhirVersionExtensions for fhirVersionElement
CapabilityStatementformatA list of the formats supported by this implementation using their content types.code
CapabilityStatement_formatExtensions for formatElement
CapabilityStatementpatchFormatA list of the patch formats supported by this implementation using their content types.code
CapabilityStatement_patchFormatExtensions for patchFormatElement
CapabilityStatementimplementationGuideA list of implementation guides that the server does (or should) support in their entirety.canonical
CapabilityStatementrestA definition of the restful capabilities of the solution, if any.CapabilityStatement_Rest
CapabilityStatementmessagingA description of the messaging capabilities of the solution.CapabilityStatement_Messaging
CapabilityStatementdocumentA document definition.CapabilityStatement_Document
CapabilityStatement2resourceTypeThis is a CapabilityStatement2 resourceCapabilityStatement2
CapabilityStatement2idThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CapabilityStatement2metaThe metadata about the resource. 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
CapabilityStatement2implicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
CapabilityStatement2_implicitRulesExtensions for implicitRulesElement
CapabilityStatement2languageThe base language in which the resource is written.code
CapabilityStatement2_languageExtensions for languageElement
CapabilityStatement2textA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CapabilityStatement2containedThese 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
CapabilityStatement2extensionMay be 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
CapabilityStatement2modifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CapabilityStatement2urlAn absolute URI that is used to identify this capability statement2 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 statement2 is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement2 is stored on different servers.uri
CapabilityStatement2_urlExtensions for urlElement
CapabilityStatement2identifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
CapabilityStatement2versionThe identifier that is used to identify this version of the capability statement2 when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement2 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
CapabilityStatement2_versionExtensions for versionElement
CapabilityStatement2nameA natural language name identifying the capability statement2. This name should be usable as an identifier for the module by machine processing applications such as code generation.string
CapabilityStatement2_nameExtensions for nameElement
CapabilityStatement2titleA short, descriptive, user-friendly title for the capability statement2.string
CapabilityStatement2_titleExtensions for titleElement
CapabilityStatement2statusThe status of this capability statement2. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
CapabilityStatement2_statusExtensions for statusElement
CapabilityStatement2experimentalA Boolean value to indicate that this capability statement2 is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.boolean
CapabilityStatement2_experimentalExtensions for experimentalElement
CapabilityStatement2dateThe date (and optionally time) when the capability statement2 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 statement2 changes.dateTime
CapabilityStatement2_dateExtensions for dateElement
CapabilityStatement2publisherThe name of the organization or individual that published the capability statement2.string
CapabilityStatement2_publisherExtensions for publisherElement
CapabilityStatement2contactContact details to assist a user in finding and communicating with the publisher.ContactDetail
CapabilityStatement2descriptionA free text natural language description of the capability statement2 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
CapabilityStatement2_descriptionExtensions for descriptionElement
CapabilityStatement2useContextThe 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 statement2 instances.UsageContext
CapabilityStatement2jurisdictionA legal or geographic region in which the capability statement2 is intended to be used.CodeableConcept
CapabilityStatement2purposeExplanation of why this capability statement2 is needed and why it has been designed as it has.markdown
CapabilityStatement2_purposeExtensions for purposeElement
copyrightA copyright statement relating to the capability statement2 and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement2.markdown
_copyrightExtensions for copyrightElement
CapabilityStatement2kindThe 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
CapabilityStatement2_kindExtensions for kindElement
CapabilityStatement2instantiatesReference to a canonical URL of another CapabilityStatement2 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
CapabilityStatement2importsReference to a canonical URL of another CapabilityStatement2 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
CapabilityStatement2softwareSoftware 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.CapabilityStatement2_Software
CapabilityStatement2implementationIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.CapabilityStatement2_Implementation
CapabilityStatement2fhirVersionThe version of the FHIR specification that this CapabilityStatement2 describes (which SHALL be the same as the FHIR version of the CapabilityStatement2 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.0.2
3.3.0
3.5.0
4.0.0
4.0.1
4.1.0
4.2.0
4.4.0
CapabilityStatement2_fhirVersionExtensions for fhirVersionElement
CapabilityStatement2formatA list of the formats supported by this implementation using their content types.code
CapabilityStatement2_formatExtensions for formatElement
CapabilityStatement2patchFormatA list of the patch formats supported by this implementation using their content types.code
CapabilityStatement2_patchFormatExtensions for patchFormatElement
CapabilityStatement2implementationGuideA list of implementation guides that the server does (or should) support in their entirety.canonical
CapabilityStatement2restA definition of the restful capabilities of the solution, if any.CapabilityStatement2_Rest
CapabilityStatement2_ImplementationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_ImplementationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_ImplementationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_ImplementationdescriptionInformation about the specific installation that this capability statement relates to.string
CapabilityStatement2_Implementation_descriptionExtensions for descriptionElement
CapabilityStatement2_ImplementationurlAn absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.url
CapabilityStatement2_Implementation_urlExtensions for urlElement
CapabilityStatement2_ImplementationcustodianThe organization responsible for the management of the instance and oversight of the data on the server at the specified URL.Reference
CapabilityStatement2_InteractionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_InteractionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_InteractionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_InteractioncodeCoded identifier of the operation, supported by the system resource.code
CapabilityStatement2_Interaction_codeExtensions for codeElement
CapabilityStatement2_InteractiondocumentationGuidance 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
CapabilityStatement2_Interaction_documentationExtensions for documentationElement
CapabilityStatement2_Interaction1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_Interaction1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_Interaction1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_Interaction1codeA coded identifier of the operation, supported by the system.code
CapabilityStatement2_Interaction1_codeExtensions for codeElement
CapabilityStatement2_Interaction1documentationGuidance 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
CapabilityStatement2_Interaction1_documentationExtensions for documentationElement
CapabilityStatement2_OperationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_OperationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_OperationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_OperationnameThe 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
CapabilityStatement2_Operation_nameExtensions for nameElement
CapabilityStatement2_OperationdefinitionWhere 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
CapabilityStatement2_OperationdocumentationDocumentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.markdown
CapabilityStatement2_Operation_documentationExtensions for documentationElement
CapabilityStatement2_ResourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_ResourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_ResourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_ResourcetypeA type of resource exposed via the restful interface.code
CapabilityStatement2_Resource_typeExtensions for typeElement
CapabilityStatement2_ResourceprofileA 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
CapabilityStatement2_ResourcesupportedProfileA 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
CapabilityStatement2_ResourcedocumentationAdditional information about the resource type used by the system.markdown
CapabilityStatement2_Resource_documentationExtensions for documentationElement
CapabilityStatement2_ResourceinteractionIdentifies a restful operation supported by the solution.CapabilityStatement2_Interaction
CapabilityStatement2_ResourcesearchParamSearch 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.CapabilityStatement2_SearchParam
CapabilityStatement2_ResourceoperationDefinition 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.CapabilityStatement2_Operation
CapabilityStatement2_RestidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_RestextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_RestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_RestmodeIdentifies whether this portion of the statement is describing the ability to initiate or receive restful operations.code
CapabilityStatement2_Rest_modeExtensions for modeElement
CapabilityStatement2_RestdocumentationInformation about the system's restful capabilities that apply across all applications, such as security.markdown
CapabilityStatement2_Rest_documentationExtensions for documentationElement
CapabilityStatement2_RestresourceA specification of the restful capabilities of the solution for a specific resource type.CapabilityStatement2_Resource
CapabilityStatement2_RestinteractionA specification of restful operations supported by the system.CapabilityStatement2_Interaction1
CapabilityStatement2_RestsearchParamSearch 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.CapabilityStatement2_SearchParam
CapabilityStatement2_RestoperationDefinition of an operation or a named query together with its parameters and their meaning and type.CapabilityStatement2_Operation
CapabilityStatement2_RestcompartmentAn 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
CapabilityStatement2_SearchParamidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_SearchParamextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_SearchParammodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_SearchParamnameThe name of the search parameter used in the interface.string
CapabilityStatement2_SearchParam_nameExtensions for nameElement
CapabilityStatement2_SearchParamdefinitionAn 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
CapabilityStatement2_SearchParamtypeThe 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
CapabilityStatement2_SearchParam_typeExtensions for typeElement
CapabilityStatement2_SearchParamdocumentationThis allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.markdown
CapabilityStatement2_SearchParam_documentationExtensions for documentationElement
CapabilityStatement2_SoftwareidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement2_SoftwareextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CapabilityStatement2_SoftwaremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
CapabilityStatement2_SoftwarenameName the software is known by.string
CapabilityStatement2_Software_nameExtensions for nameElement
CapabilityStatement2_SoftwareversionThe version identifier for the software covered by this statement.string
CapabilityStatement2_Software_versionExtensions for versionElement
CapabilityStatement2_SoftwarereleaseDateDate this version of the software was released.dateTime
CapabilityStatement2_Software_releaseDateExtensions for releaseDateElement
CapabilityStatement_DocumentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_DocumentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DocumentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DocumentmodeMode of this document declaration - whether an application is a producer or consumer.enum values:
producer
consumer
CapabilityStatement_Document_modeExtensions for modeElement
CapabilityStatement_DocumentdocumentationA 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_documentationExtensions for documentationElement
CapabilityStatement_DocumentprofileA profile on the document Bundle that constrains which resources are present, and their contents.canonical
CapabilityStatement_EndpointidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_EndpointextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EndpointmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EndpointprotocolA list of the messaging transport protocol(s) identifiers, supported by this endpoint.Coding
CapabilityStatement_EndpointaddressThe network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.url
CapabilityStatement_Endpoint_addressExtensions for addressElement
CapabilityStatement_ImplementationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_ImplementationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ImplementationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ImplementationdescriptionInformation about the specific installation that this capability statement relates to.string
CapabilityStatement_Implementation_descriptionExtensions for descriptionElement
CapabilityStatement_ImplementationurlAn absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.url
CapabilityStatement_Implementation_urlExtensions for urlElement
CapabilityStatement_ImplementationcustodianThe organization responsible for the management of the instance and oversight of the data on the server at the specified URL.Reference
CapabilityStatement_InteractionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_InteractionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InteractionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InteractioncodeCoded 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_codeExtensions for codeElement
CapabilityStatement_InteractiondocumentationGuidance 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_documentationExtensions for documentationElement
CapabilityStatement_Interaction1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_Interaction1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Interaction1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Interaction1codeA coded identifier of the operation, supported by the system.enum values:
transaction
batch
search-system
history-system
CapabilityStatement_Interaction1_codeExtensions for codeElement
CapabilityStatement_Interaction1documentationGuidance 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_documentationExtensions for documentationElement
CapabilityStatement_MessagingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_MessagingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MessagingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MessagingendpointAn endpoint (network accessible address) to which messages and/or replies are to be sent.CapabilityStatement_Endpoint
CapabilityStatement_MessagingreliableCacheLength 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_reliableCacheExtensions for reliableCacheElement
CapabilityStatement_MessagingdocumentationDocumentation 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_documentationExtensions for documentationElement
CapabilityStatement_MessagingsupportedMessageReferences to message definitions for messages this system can send or receive.CapabilityStatement_SupportedMessage
CapabilityStatement_OperationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_OperationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OperationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OperationnameThe 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_nameExtensions for nameElement
CapabilityStatement_OperationdefinitionWhere 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_OperationdocumentationDocumentation 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_documentationExtensions for documentationElement
CapabilityStatement_ResourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_ResourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ResourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ResourcetypeA type of resource exposed via the restful interface.code
CapabilityStatement_Resource_typeExtensions for typeElement
CapabilityStatement_ResourceprofileA 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_ResourcesupportedProfileA 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_ResourcedocumentationAdditional information about the resource type used by the system.markdown
CapabilityStatement_Resource_documentationExtensions for documentationElement
CapabilityStatement_ResourceinteractionIdentifies a restful operation supported by the solution.CapabilityStatement_Interaction
CapabilityStatement_ResourceversioningThis 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_versioningExtensions for versioningElement
CapabilityStatement_ResourcereadHistoryA flag for whether the server is able to return past versions as part of the vRead operation.boolean
CapabilityStatement_Resource_readHistoryExtensions for readHistoryElement
CapabilityStatement_ResourceupdateCreateA 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_updateCreateExtensions for updateCreateElement
CapabilityStatement_ResourceconditionalCreateA flag that indicates that the server supports conditional create.boolean
CapabilityStatement_Resource_conditionalCreateExtensions for conditionalCreateElement
CapabilityStatement_ResourceconditionalReadA code that indicates how the server supports conditional read.enum values:
not-supported
modified-since
not-match
full-support
CapabilityStatement_Resource_conditionalReadExtensions for conditionalReadElement
CapabilityStatement_ResourceconditionalUpdateA flag that indicates that the server supports conditional update.boolean
CapabilityStatement_Resource_conditionalUpdateExtensions for conditionalUpdateElement
CapabilityStatement_ResourceconditionalDeleteA code that indicates how the server supports conditional delete.enum values:
not-supported
single
multiple
CapabilityStatement_Resource_conditionalDeleteExtensions for conditionalDeleteElement
CapabilityStatement_ResourcereferencePolicyA set of flags that defines how references are supported.enum values:
literal
logical
resolves
enforced
local
CapabilityStatement_Resource_referencePolicyExtensions for referencePolicyElement
CapabilityStatement_ResourcesearchIncludeA list of _include values supported by the server.string
CapabilityStatement_Resource_searchIncludeExtensions for searchIncludeElement
CapabilityStatement_ResourcesearchRevIncludeA list of _revinclude (reverse include) values supported by the server.string
CapabilityStatement_Resource_searchRevIncludeExtensions for searchRevIncludeElement
CapabilityStatement_ResourcesearchParamSearch 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_ResourceoperationDefinition 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_RestidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_RestextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RestmodeIdentifies whether this portion of the statement is describing the ability to initiate or receive restful operations.enum values:
client
server
CapabilityStatement_Rest_modeExtensions for modeElement
CapabilityStatement_RestdocumentationInformation about the system's restful capabilities that apply across all applications, such as security.markdown
CapabilityStatement_Rest_documentationExtensions for documentationElement
CapabilityStatement_RestsecurityInformation about security implementation from an interface perspective - what a client needs to know.CapabilityStatement_Security
CapabilityStatement_RestresourceA specification of the restful capabilities of the solution for a specific resource type.CapabilityStatement_Resource
CapabilityStatement_RestinteractionA specification of restful operations supported by the system.CapabilityStatement_Interaction1
CapabilityStatement_RestsearchParamSearch 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_RestoperationDefinition of an operation or a named query together with its parameters and their meaning and type.CapabilityStatement_Operation
CapabilityStatement_RestcompartmentAn 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_SearchParamidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_SearchParamextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SearchParammodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SearchParamnameThe name of the search parameter used in the interface.string
CapabilityStatement_SearchParam_nameExtensions for nameElement
CapabilityStatement_SearchParamdefinitionAn 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_SearchParamtypeThe 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_typeExtensions for typeElement
CapabilityStatement_SearchParamdocumentationThis allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.markdown
CapabilityStatement_SearchParam_documentationExtensions for documentationElement
CapabilityStatement_SecurityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_SecurityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SecuritymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SecuritycorsServer adds CORS headers when responding to requests - this enables Javascript applications to use the server.boolean
CapabilityStatement_Security_corsExtensions for corsElement
CapabilityStatement_SecurityserviceTypes of security services that are supported/required by the system.CodeableConcept
CapabilityStatement_SecuritydescriptionGeneral description of how security works.markdown
CapabilityStatement_Security_descriptionExtensions for descriptionElement
CapabilityStatement_SoftwareidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_SoftwareextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SoftwaremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SoftwarenameName the software is known by.string
CapabilityStatement_Software_nameExtensions for nameElement
CapabilityStatement_SoftwareversionThe version identifier for the software covered by this statement.string
CapabilityStatement_Software_versionExtensions for versionElement
CapabilityStatement_SoftwarereleaseDateDate this version of the software was released.dateTime
CapabilityStatement_Software_releaseDateExtensions for releaseDateElement
CapabilityStatement_SupportedMessageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CapabilityStatement_SupportedMessageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SupportedMessagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SupportedMessagemodeThe mode of this event declaration - whether application is sender or receiver.enum values:
sender
receiver
CapabilityStatement_SupportedMessage_modeExtensions for modeElement
CapabilityStatement_SupportedMessagedefinitionPoints to a message definition that identifies the messaging event, message structure, allowed responses, etc.canonical
CarePlanresourceTypeThis is a CarePlan resourceCarePlan
CarePlanidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CarePlanmetaThe metadata about the resource. 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
CarePlanimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CarePlanlanguageThe base language in which the resource is written.code
CarePlan_languageExtensions for languageElement
CarePlantextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CarePlancontainedThese 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
CarePlanextensionMay be 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
CarePlanmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CarePlanidentifierBusiness 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
CarePlaninstantiatesCanonicalThe 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
CarePlaninstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
CarePlanbasedOnA care plan that is fulfilled in whole or in part by this care plan.Reference
CarePlanreplacesCompleted or terminated care plan whose function is taken by this new care plan.Reference
CarePlanpartOfA larger care plan of which this particular care plan is a component or step.Reference
CarePlanstatusIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.code
CarePlan_statusExtensions for statusElement
CarePlanintentIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.code
CarePlan_intentExtensions for intentElement
CarePlancategoryIdentifies 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
CarePlantitleHuman-friendly name for the care plan.string
CarePlan_titleExtensions for titleElement
CarePlandescriptionA description of the scope and nature of the plan.string
CarePlan_descriptionExtensions for descriptionElement
CarePlansubjectIdentifies the patient or group whose intended care is described by the plan.Reference
CarePlanencounterThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.Reference
CarePlanperiodIndicates when the plan did (or is intended to) come into effect and end.Period
CarePlancreatedRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.dateTime
CarePlan_createdExtensions for createdElement
CarePlanauthorWhen populated, the author is responsible for the care plan. The care plan is attributed to the author.Reference
CarePlancontributorIdentifies the individual(s) or organization who provided the contents of the care plan.Reference
CarePlancareTeamIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan.Reference
CarePlanaddressesIdentifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.CodeableReference
CarePlansupportingInfoIdentifies 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
CarePlangoalDescribes the intended objective(s) of carrying out the care plan.Reference
CarePlanactivityIdentifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.CarePlan_Activity
CarePlannoteGeneral notes about the care plan not covered elsewhere.Annotation
CarePlan_ActivityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CarePlan_ActivityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ActivitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ActivityoutcomeIdentifies 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). 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).CodeableReference
CarePlan_ActivityprogressNotes about the adherence/status/progress of the activity.Annotation
CarePlan_ActivityreferenceThe details of the proposed activity represented in a specific resource.Reference
CarePlan_ActivitydetailA 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_DetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CarePlan_DetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DetailkindA 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_kindExtensions for kindElement
CarePlan_DetailinstantiatesCanonicalThe 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_DetailinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
CarePlan_DetailcodeDetailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.CodeableConcept
CarePlan_DetailreasonProvides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited - either a coded concept, or 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.CodeableReference
CarePlan_DetailgoalInternal reference that identifies the goals that this activity is intended to contribute towards meeting.Reference
CarePlan_DetailstatusIdentifies 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_statusExtensions for statusElement
CarePlan_DetailstatusReasonProvides reason why the activity isn't yet started, is on hold, was cancelled, etc.CodeableConcept
CarePlan_DetaildoNotPerformIf 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_doNotPerformExtensions for doNotPerformElement
CarePlan_DetailscheduledTimingThe period, timing or frequency upon which the described activity is to occur.Timing
CarePlan_DetailscheduledPeriodThe period, timing or frequency upon which the described activity is to occur.Period
CarePlan_DetailscheduledStringThe period, timing or frequency upon which the described activity is to occur.notDefined
CarePlan_Detail_scheduledStringExtensions for scheduledStringElement
CarePlan_DetaillocationIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.CodeableReference
CarePlan_DetailreportedBooleanIndicates 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
CarePlan_Detail_reportedBooleanExtensions for reportedBooleanElement
CarePlan_DetailreportedReferenceIndicates 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
CarePlan_DetailperformerIdentifies who's expected to be involved in the activity.Reference
CarePlan_DetailproductCodeableConceptIdentifies the food, drug or other product to be consumed or supplied in the activity.CodeableConcept
CarePlan_DetailproductReferenceIdentifies the food, drug or other product to be consumed or supplied in the activity.Reference
CarePlan_DetaildailyAmountIdentifies the quantity expected to be consumed in a given day.Quantity
CarePlan_DetailquantityIdentifies the quantity expected to be supplied, administered or consumed by the subject.Quantity
CarePlan_DetaildescriptionThis 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_descriptionExtensions for descriptionElement
CareTeamresourceTypeThis is a CareTeam resourceCareTeam
CareTeamidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CareTeammetaThe metadata about the resource. 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
CareTeamimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CareTeamlanguageThe base language in which the resource is written.code
CareTeam_languageExtensions for languageElement
CareTeamtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CareTeamcontainedThese 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
CareTeamextensionMay be 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
CareTeammodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CareTeamidentifierBusiness 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
CareTeamstatusIndicates the current state of the care team.enum values:
proposed
active
suspended
inactive
entered-in-error
CareTeam_statusExtensions for statusElement
CareTeamcategoryIdentifies 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
CareTeamnameA label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.string
CareTeam_nameExtensions for nameElement
CareTeamsubjectIdentifies the patient or group whose intended care is handled by the team.Reference
CareTeamperiodIndicates when the team did (or is intended to) come into effect and end.Period
CareTeamparticipantIdentifies all people and organizations who are expected to be involved in the care team.CareTeam_Participant
CareTeamreasonDescribes why the care team exists.CodeableReference
CareTeammanagingOrganizationThe organization responsible for the care team.Reference
CareTeamtelecomA central contact detail for the care team (that applies to all members).ContactPoint
CareTeamnoteComments made about the CareTeam.Annotation
CareTeam_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CareTeam_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipantroleIndicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.CodeableConcept
CareTeam_ParticipantmemberThe specific person or organization who is participating/expected to participate in the care team.Reference
CareTeam_ParticipantonBehalfOfThe organization of the practitioner.Reference
CareTeam_ParticipantcoveragePeriodWhen the member is generally available within this care team.Period
CareTeam_ParticipantcoverageTimingWhen the member is generally available within this care team.Timing
CatalogEntryresourceTypeThis is a CatalogEntry resourceCatalogEntry
CatalogEntryidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CatalogEntrymetaThe metadata about the resource. 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
CatalogEntryimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CatalogEntrylanguageThe base language in which the resource is written.code
CatalogEntry_languageExtensions for languageElement
CatalogEntrytextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CatalogEntrycontainedThese 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
CatalogEntryextensionMay be 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
CatalogEntrymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CatalogEntryidentifierBusiness identifier uniquely assigned to the catalog entry.Identifier
CatalogEntrynameThe name of this catalog entry announces the item that is represented by the entry.string
CatalogEntry_nameExtensions for nameElement
CatalogEntrytypeThe type of resource that is represented by this catalog entry.enum values:
ActivityDefinition
PlanDefinition
SpecimenDefinition
ObservationDefinition
DeviceDefinition
Organization
Practitioner
PractitionerRole
HealthcareService
MedicationKnowledge
Medication
Substance
Location
CatalogEntry_typeExtensions for typeElement
CatalogEntrystatusIndicates whether this catalog entry is open to public usage (active) or not (draft or retired).enum values:
draft
active
retired
CatalogEntry_statusExtensions for statusElement
CatalogEntryeffectivePeriodPeriod of usability of the catalog entry.Period
CatalogEntryorderableIndicates whether or not the entry represents an item that is orderable.boolean
CatalogEntry_orderableExtensions for orderableElement
CatalogEntryreferencedItemThe item (resource) that this entry of the catalog represents.Reference
CatalogEntryrelatedEntryUsed for example, to point to a substance, or to a device used to administer a medication.CatalogEntry_RelatedEntry
CatalogEntryupdatedByLast actor who recorded (created or updated) this catalog entry.Reference
CatalogEntrynoteNotes and comments about this catalog entry.Annotation
CatalogEntryestimatedDurationEstimated duration of the orderable item of this entry of the catalog.Duration
CatalogEntrybillingCodeBilling code associated to the item in the context of this entry of the catalog.CodeableConcept
CatalogEntrybillingSummaryBilling summary attached to the item in the context of this entry of the catalog.string
CatalogEntry_billingSummaryExtensions for billingSummaryElement
CatalogEntryscheduleSummarySchedule summary for the item in the context of this entry of the catalog.string
CatalogEntry_scheduleSummaryExtensions for scheduleSummaryElement
CatalogEntrylimitationSummarySummary of limitations for the item in the context of this entry of the catalog.string
CatalogEntry_limitationSummaryExtensions for limitationSummaryElement
CatalogEntryregulatorySummaryRegulatory summary for the item in the context of this entry of the catalog.string
CatalogEntry_regulatorySummaryExtensions for regulatorySummaryElement
CatalogEntry_RelatedEntryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CatalogEntry_RelatedEntryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RelatedEntrymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RelatedEntryrelationshipThe type of relationship to the related entry.enum values:
triggers
is-replaced-by
excludes
includes
CatalogEntry_RelatedEntry_relationshipExtensions for relationshipElement
CatalogEntry_RelatedEntrytargetThe reference to the related entry.Reference
ChargeItemresourceTypeThis is a ChargeItem resourceChargeItem
ChargeItemidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ChargeItemmetaThe metadata about the resource. 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
ChargeItemimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ChargeItemlanguageThe base language in which the resource is written.code
ChargeItem_languageExtensions for languageElement
ChargeItemtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ChargeItemcontainedThese 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
ChargeItemextensionMay be 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
ChargeItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ChargeItemidentifierIdentifiers assigned to this event performer or other systems.Identifier
ChargeItemdefinitionUriReferences the (external) source of pricing information, rules of application for the code this ChargeItem uses.uri
ChargeItem_definitionUriExtensions for definitionUriElement
ChargeItemdefinitionCanonicalReferences the source of pricing information, rules of application for the code this ChargeItem uses.canonical
ChargeItemstatusThe current state of the ChargeItem.enum values:
planned
billable
not-billable
aborted
billed
entered-in-error
unknown
ChargeItem_statusExtensions for statusElement
ChargeItempartOfChargeItems can be grouped to larger ChargeItems covering the whole set.Reference
ChargeItemcodeA code that identifies the charge, like a billing code.CodeableConcept
ChargeItemsubjectThe individual or set of individuals the action is being or was performed on.Reference
ChargeItemcontextThe encounter or episode of care that establishes the context for this event.Reference
ChargeItemoccurrenceDateTimeDate/time(s) or duration when the charged service was applied.notDefined
ChargeItem_occurrenceDateTimeExtensions for occurrenceDateTimeElement
ChargeItemoccurrencePeriodDate/time(s) or duration when the charged service was applied.Period
ChargeItemoccurrenceTimingDate/time(s) or duration when the charged service was applied.Timing
ChargeItemperformerIndicates who or what performed or participated in the charged service.ChargeItem_Performer
ChargeItemperformingOrganizationThe organization requesting the service.Reference
ChargeItemrequestingOrganizationThe organization performing the service.Reference
ChargeItemcostCenterThe financial cost center permits the tracking of charge attribution.Reference
ChargeItemquantityQuantity of which the charge item has been serviced.Quantity
ChargeItembodysiteThe anatomical location where the related service has been applied.CodeableConcept
ChargeItemfactorOverrideFactor overriding the factor determined by the rules associated with the code.decimal
ChargeItem_factorOverrideExtensions for factorOverrideElement
ChargeItempriceOverrideTotal price of the charge overriding the list price associated with the code.Money
ChargeItemoverrideReasonIf 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_overrideReasonExtensions for overrideReasonElement
ChargeItementererThe device, practitioner, etc. who entered the charge item.Reference
ChargeItementeredDateDate the charge item was entered.dateTime
ChargeItem_enteredDateExtensions for enteredDateElement
ChargeItemreasonDescribes why the event occurred in coded or textual form.CodeableConcept
ChargeItemserviceIndicated the rendered service that caused this charge.Reference
ChargeItemproductReferenceIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.Reference
ChargeItemproductCodeableConceptIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.CodeableConcept
ChargeItemaccountAccount into which this ChargeItems belongs.Reference
ChargeItemnoteComments made about the event by the performer, subject or other participants.Annotation
ChargeItemsupportingInformationFurther information supporting this charge.Reference
ChargeItemDefinitionresourceTypeThis is a ChargeItemDefinition resourceChargeItemDefinition
ChargeItemDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ChargeItemDefinitionmetaThe metadata about the resource. 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
ChargeItemDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ChargeItemDefinitionlanguageThe base language in which the resource is written.code
ChargeItemDefinition_languageExtensions for languageElement
ChargeItemDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ChargeItemDefinitioncontainedThese 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
ChargeItemDefinitionextensionMay be 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
ChargeItemDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ChargeItemDefinitionurlAn 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_urlExtensions for urlElement
ChargeItemDefinitionidentifierA 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
ChargeItemDefinitionversionThe 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_versionExtensions for versionElement
ChargeItemDefinitionnameA natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.string
ChargeItemDefinition_nameExtensions for nameElement
ChargeItemDefinitiontitleA short, descriptive, user-friendly title for the charge item definition.string
ChargeItemDefinition_titleExtensions for titleElement
ChargeItemDefinitionstatusThe current state of the ChargeItemDefinition.enum values:
draft
active
retired
unknown
ChargeItemDefinition_statusExtensions for statusElement
ChargeItemDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
ChargeItemDefinitiondateThe 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_dateExtensions for dateElement
ChargeItemDefinitionpublisherThe name of the organization or individual that published the charge item definition.string
ChargeItemDefinition_publisherExtensions for publisherElement
ChargeItemDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ChargeItemDefinitiondescriptionA free text natural language description of the charge item definition from a consumer's perspective.markdown
ChargeItemDefinition_descriptionExtensions for descriptionElement
ChargeItemDefinitionuseContextThe 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
ChargeItemDefinitionjurisdictionA legal or geographic region in which the charge item definition is intended to be used.CodeableConcept
ChargeItemDefinitionpurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
ChargeItemDefinition_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
ChargeItemDefinitionapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
ChargeItemDefinition_approvalDateExtensions for approvalDateElement
ChargeItemDefinitionlastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
ChargeItemDefinition_lastReviewDateExtensions for lastReviewDateElement
ChargeItemDefinitioneffectivePeriodThe period during which the charge item definition content was or is planned to be in active use.Period
ChargeItemDefinitionderivedFromUriThe URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.uri
ChargeItemDefinition_derivedFromUriExtensions for derivedFromUriElement
ChargeItemDefinitionpartOfA larger definition of which this particular definition is a component or step.canonical
ChargeItemDefinitionreplacesAs new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.canonical
ChargeItemDefinitioncodeThe defined billing details in this resource pertain to the given billing code.CodeableConcept
ChargeItemDefinitioninstanceThe defined billing details in this resource pertain to the given product instance(s).Reference
ChargeItemDefinitionapplicabilityExpressions that describe applicability criteria for the billing code.ChargeItemDefinition_Applicability
ChargeItemDefinitionpropertyGroupGroup 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_ApplicabilityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ChargeItemDefinition_ApplicabilityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ApplicabilitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ApplicabilitydescriptionA brief, natural language description of the condition that effectively communicates the intended semantics.string
ChargeItemDefinition_Applicability_descriptionExtensions for descriptionElement
ChargeItemDefinition_ApplicabilitylanguageThe 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_languageExtensions for languageElement
ChargeItemDefinition_ApplicabilityexpressionAn 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_expressionExtensions for expressionElement
ChargeItemDefinition_PriceComponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ChargeItemDefinition_PriceComponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PriceComponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PriceComponenttypeThis code identifies the type of the component.code
ChargeItemDefinition_PriceComponent_typeExtensions for typeElement
ChargeItemDefinition_PriceComponentcodeA code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.CodeableConcept
ChargeItemDefinition_PriceComponentfactorThe factor that has been applied on the base price for calculating this component.decimal
ChargeItemDefinition_PriceComponent_factorExtensions for factorElement
ChargeItemDefinition_PriceComponentamountThe amount calculated for this component.Money
ChargeItemDefinition_PropertyGroupidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ChargeItemDefinition_PropertyGroupextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PropertyGroupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PropertyGroupapplicabilityExpressions that describe applicability criteria for the priceComponent.ChargeItemDefinition_Applicability
ChargeItemDefinition_PropertyGrouppriceComponentThe 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_PerformeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ChargeItem_PerformerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PerformermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PerformerfunctionDescribes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).CodeableConcept
ChargeItem_PerformeractorThe device, practitioner, etc. who performed or participated in the service.Reference
CitationresourceTypeThis is a Citation resourceCitation
CitationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CitationmetaThe metadata about the resource. 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
CitationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
Citation_implicitRulesExtensions for implicitRulesElement
CitationlanguageThe base language in which the resource is written.code
Citation_languageExtensions for languageElement
CitationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CitationcontainedThese 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
CitationextensionMay be 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
CitationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CitationurlAn absolute URI that is used to identify this citation 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 summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.uri
Citation_urlExtensions for urlElement
CitationidentifierA formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. May include DOI, PMID, PMCID, etc.Identifier
CitationversionThe identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.string
Citation_versionExtensions for versionElement
CitationnameA natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.string
Citation_nameExtensions for nameElement
CitationtitleA short, descriptive, user-friendly title for the {{title}}.string
Citation_titleExtensions for titleElement
CitationstatusThe status of this summary. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
Citation_statusExtensions for statusElement
CitationexperimentalA Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.boolean
Citation_experimentalExtensions for experimentalElement
CitationdateThe date (and optionally time) when the {{title}} 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 {{title}} changes.dateTime
Citation_dateExtensions for dateElement
CitationpublisherThe name of the organization or individual that published the {{title}}.string
Citation_publisherExtensions for publisherElement
CitationcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
CitationdescriptionA free text natural language description of the {{title}} from a consumer's perspective.markdown
Citation_descriptionExtensions for descriptionElement
CitationuseContextThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.UsageContext
CitationjurisdictionA legal or geographic region in which the {{title}} is intended to be used.CodeableConcept
CitationpurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
Citation_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
CitationapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
Citation_approvalDateExtensions for approvalDateElement
CitationlastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
Citation_lastReviewDateExtensions for lastReviewDateElement
CitationeffectivePeriodThe period during which the {{title}} content was or is planned to be in active use.Period
CitationrelatedIdentifierMay include trial registry identifiers.Identifier
CitationdateCitedDate Cited.dateTime
Citation_dateCitedExtensions for dateCitedElement
CitationvariantCitationVariant citation.Citation_VariantCitation
CitationpublishingModelIdentify the medium/media in which the cited article is published, eg print, electronic or print-electronic.CodeableConcept
CitationjournalContains identifiers and classifiers for the journal cited.Citation_Journal
CitationarticleTitleFull title of the article.markdown
Citation_articleTitleExtensions for articleTitleElement
CitationalternativeTitleUsed for variant titles, such as translations.Citation_AlternativeTitle
CitationpaginationIndicates the inclusive pages for the article cited.Citation_Pagination
CitationarticleUrlUsed for any URL for the article cited.Citation_ArticleUrl
CitationabstractAbstract text, may include structured labels.markdown
Citation_abstractExtensions for abstractElement
CitationabstractCopyrightCopyright information for the abstract text.markdown
Citation_abstractCopyrightExtensions for abstractCopyrightElement
CitationalternativeAbstractUsed for variant abstracts, such as translations.Citation_AlternativeAbstract
CitationauthorListPersonal and collective author names.Citation_AuthorList
CitationauthorStringUsed to record a display of the author list without separate coding for each author.Citation_AuthorString
CitationcontributorListPersonal and collective contributor names.Citation_ContributorList
CitationarticleLanguageThe language in which the article is published.CodeableConcept
CitationalternativeFormUsed to represent alternative forms of the article that are not separate citations.Citation_AlternativeForm
CitationclassifierUsed for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical.CodeableConcept
CitationrelatedArtifactUsed for referencing EvidenceReport resource.RelatedArtifact
CitationnoteUsed for general notes and annotations not coded elsewhere.Annotation
CitationmedlinePubMedThese elements are items with values assigned by MEDLINE or PubMed management.Citation_MedlinePubMed
Citation_AffiliationInfoidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AffiliationInfoextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AffiliationInfomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AffiliationInfoaffiliationDisplay for the organization.string
Citation_AffiliationInfo_affiliationExtensions for affiliationElement
Citation_AffiliationInforoleRole.string
Citation_AffiliationInfo_roleExtensions for roleElement
Citation_AffiliationInfoidentifierIdentifier for the organization.Identifier
Citation_AffiliationInfo1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AffiliationInfo1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AffiliationInfo1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AffiliationInfo1affiliationDisplay for the organization.string
Citation_AffiliationInfo1_affiliationExtensions for affiliationElement
Citation_AffiliationInfo1roleRole.string
Citation_AffiliationInfo1_roleExtensions for roleElement
Citation_AffiliationInfo1identifierIdentifier for the organization.Identifier
Citation_AlternativeAbstractidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AlternativeAbstractextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AlternativeAbstractmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AlternativeAbstracttypeUsed to express the reason for the variant abstract, such as language.CodeableConcept
Citation_AlternativeAbstractlanguageUsed to express the specific language.CodeableConcept
Citation_AlternativeAbstractabstractFull variant abstract of the article.markdown
Citation_AlternativeAbstract_abstractExtensions for abstractElement
Citation_AlternativeAbstractabstractCopyrightCopyright information for the abstract text.markdown
Citation_AlternativeAbstract_abstractCopyrightExtensions for abstractCopyrightElement
Citation_AlternativeFormidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AlternativeFormextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AlternativeFormmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AlternativeFormpublishingModelIdentify the medium/media in which the cited article is published, eg print, electronic or print-electronic.CodeableConcept
Citation_AlternativeFormlanguageLanguage in which the article is published.CodeableConcept
Citation_AlternativeFormjournalIssueThe specific issue in which the cited article resides.Citation_JournalIssue1
Citation_AlternativeFormpaginationIndicates the inclusive pages for the article cited.Citation_Pagination1
Citation_AlternativeTitleidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AlternativeTitleextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AlternativeTitlemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AlternativeTitletypeUsed to express the reason and specific aspect for the variant title, such as language and specific language.CodeableConcept
Citation_AlternativeTitlelanguageUsed to express the specific language.CodeableConcept
Citation_AlternativeTitletitleFull variant title of the article.markdown
Citation_AlternativeTitle_titleExtensions for titleElement
Citation_ArticleUrlidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_ArticleUrlextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_ArticleUrlmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_ArticleUrltypeCode the reason for different URLs, eg abstract and full-text.CodeableConcept
Citation_ArticleUrlurlThe specific URL.uri
Citation_ArticleUrl_urlExtensions for urlElement
Citation_AuthoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AuthorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AuthormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AuthorlastNameSurname or single name.string
Citation_Author_lastNameExtensions for lastNameElement
Citation_AuthorforeNameRemainder of name except for suffix.string
Citation_Author_foreNameExtensions for foreNameElement
Citation_AuthorsuffixEg 2nd, 3rd, Jr, Sr.string
Citation_Author_suffixExtensions for suffixElement
Citation_AuthorinitialsInitials for forename.string
Citation_Author_initialsExtensions for initialsElement
Citation_AuthorcollectiveNameUsed for collective or corporate name as an author.string
Citation_Author_collectiveNameExtensions for collectiveNameElement
Citation_AuthoridentifierAuthor identifier, eg ORCID.Identifier
Citation_AuthoraffiliationInfoOrganizational affiliation.Citation_AffiliationInfo
Citation_AuthoraddressPhysical mailing address for the author.string
Citation_Author_addressExtensions for addressElement
Citation_AuthortelecomEmail or telephone contact methods for the author.ContactPoint
Citation_AuthorcorrespondingAuthorIndication of which author is the corresponding author for the article cited.boolean
Citation_Author_correspondingAuthorExtensions for correspondingAuthorElement
Citation_AuthorlistOrderUsed to code order of authors.positiveInt
Citation_Author_listOrderExtensions for listOrderElement
Citation_AuthorListidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AuthorListextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AuthorListmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AuthorListcompleteIndicates if the list includes all authors, else “et al” should be appended for display.boolean
Citation_AuthorList_completeExtensions for completeElement
Citation_AuthorListauthorAn individual entity named in the author list.Citation_Author
Citation_AuthorStringidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_AuthorStringextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_AuthorStringmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_AuthorStringsourceUsed to code the producer or rule for creating the display string.CodeableConcept
Citation_AuthorStringvalueThe display string for the author list.string
Citation_AuthorString_valueExtensions for valueElement
Citation_ContributoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_ContributorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_ContributormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_ContributorlastNameSurname or single name.string
Citation_Contributor_lastNameExtensions for lastNameElement
Citation_ContributorforeNameRemainder of name except for suffix.string
Citation_Contributor_foreNameExtensions for foreNameElement
Citation_ContributorsuffixEg 2nd, 3rd, Jr, Sr.string
Citation_Contributor_suffixExtensions for suffixElement
Citation_ContributorinitialsInitials for forename.string
Citation_Contributor_initialsExtensions for initialsElement
Citation_ContributorcollectiveNameUsed for collective or corporate name as a contributor.string
Citation_Contributor_collectiveNameExtensions for collectiveNameElement
Citation_ContributoridentifierContributor identifier, eg ORCID.Identifier
Citation_ContributorcontributionThe specific contributions.CodeableConcept
Citation_ContributoraffiliationInfoOrganizational affiliation.Citation_AffiliationInfo1
Citation_ContributorlistOrderUsed to code order of contributors.positiveInt
Citation_Contributor_listOrderExtensions for listOrderElement
Citation_ContributorListidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_ContributorListextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_ContributorListmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_ContributorListcompleteIndicates if the list includes all contributors.boolean
Citation_ContributorList_completeExtensions for completeElement
Citation_ContributorListcontributorAn individual entity named in the contributor list.Citation_Contributor
Citation_JournalidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_JournalextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_JournalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_JournalidentifierJournal identifiers include ISSN, ISO Abbreviation and NLMuniqueID.Identifier
Citation_JournalcountryPlace of publication of the journal.string
Citation_Journal_countryExtensions for countryElement
Citation_JournaljournalIssueThe specific issue in which the cited article resides.Citation_JournalIssue
Citation_JournaltitleJournal title.string
Citation_Journal_titleExtensions for titleElement
Citation_JournalIssueidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_JournalIssueextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_JournalIssuemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_JournalIssuecitedMediumNLM codes Internet or Print.CodeableConcept
Citation_JournalIssuevolumeVolume number of journal in which the article is published.string
Citation_JournalIssue_volumeExtensions for volumeElement
Citation_JournalIssueissueIssue, part or supplement of journal in which the article is published.string
Citation_JournalIssue_issueExtensions for issueElement
Citation_JournalIssuepublicationDateDate on which the issue of the journal was published.string
Citation_JournalIssue_publicationDateExtensions for publicationDateElement
Citation_JournalIssue1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_JournalIssue1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_JournalIssue1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_JournalIssue1citedMediumNLM codes Internet or Print.CodeableConcept
Citation_JournalIssue1volumeVolume number of journal in which the article is published.string
Citation_JournalIssue1_volumeExtensions for volumeElement
Citation_JournalIssue1issueIssue, part or supplement of journal in which the article is published.string
Citation_JournalIssue1_issueExtensions for issueElement
Citation_JournalIssue1publicationDateDate on which the issue of the journal was published.string
Citation_JournalIssue1_publicationDateExtensions for publicationDateElement
Citation_MedlinePubMedidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_MedlinePubMedextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_MedlinePubMedmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_MedlinePubMedmedlineStateUsed for status.CodeableConcept
Citation_MedlinePubMedownerUsed for owner.CodeableConcept
Citation_MedlinePubMedpmidPubMed ID.positiveInt
Citation_MedlinePubMed_pmidExtensions for pmidElement
Citation_MedlinePubMedpmidVersionPubMed ID Version.positiveInt
Citation_MedlinePubMed_pmidVersionExtensions for pmidVersionElement
Citation_MedlinePubMeddateCreatedCreation date.date
Citation_MedlinePubMed_dateCreatedExtensions for dateCreatedElement
Citation_MedlinePubMeddateCompletedCompletion date.date
Citation_MedlinePubMed_dateCompletedExtensions for dateCompletedElement
Citation_MedlinePubMeddateRevisedRevision date.date
Citation_MedlinePubMed_dateRevisedExtensions for dateRevisedElement
Citation_MedlinePubMedpubMedPubDateSubcomponent of certainty.Citation_PubMedPubDate
Citation_MedlinePubMedpublicationStatePublication Status.CodeableConcept
Citation_MedlinePubMedrelatedArticleRelated article.Citation_RelatedArticle
Citation_PaginationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_PaginationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_PaginationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_PaginationpageStringUsed for full display of pagination.string
Citation_Pagination_pageStringExtensions for pageStringElement
Citation_PaginationfirstPageUsed for isolated representation of first page.string
Citation_Pagination_firstPageExtensions for firstPageElement
Citation_PaginationlastPageUsed for isolated representation of last page.string
Citation_Pagination_lastPageExtensions for lastPageElement
Citation_Pagination1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_Pagination1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_Pagination1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_Pagination1pageStringUsed for full display of pagination.string
Citation_Pagination1_pageStringExtensions for pageStringElement
Citation_Pagination1firstPageUsed for isolated representation of first page.string
Citation_Pagination1_firstPageExtensions for firstPageElement
Citation_Pagination1lastPageUsed for isolated representation of last page.string
Citation_Pagination1_lastPageExtensions for lastPageElement
Citation_PubMedPubDateidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_PubMedPubDateextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_PubMedPubDatemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_PubMedPubDatepublicationStatePubMed Publication Status.CodeableConcept
Citation_PubMedPubDatedatePubMed Publication Date.dateTime
Citation_PubMedPubDate_dateExtensions for dateElement
Citation_RelatedArticleidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_RelatedArticleextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_RelatedArticlemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_RelatedArticlecitationReferenceCitation Resource for related article.Reference
Citation_RelatedArticlecitationMarkdownCitation string for related article.markdown
Citation_RelatedArticle_citationMarkdownExtensions for citationMarkdownElement
Citation_RelatedArticleidentifierIdentifier for related article.Identifier
Citation_VariantCitationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Citation_VariantCitationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Citation_VariantCitationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Citation_VariantCitationtypeUsed to describe the reason for the variant citation, such as version or subpart specification.CodeableConcept
Citation_VariantCitationvalueUsed to describe the specific variation, such as version number or subpart specification.string
Citation_VariantCitation_valueExtensions for valueElement
Citation_VariantCitationbaseCitationBase citation.Reference
ClaimresourceTypeThis is a Claim resourceClaim
ClaimidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ClaimmetaThe metadata about the resource. 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
ClaimimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ClaimlanguageThe base language in which the resource is written.code
Claim_languageExtensions for languageElement
ClaimtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ClaimcontainedThese 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
ClaimextensionMay be 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
ClaimmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ClaimidentifierA unique identifier assigned to this claim.Identifier
ClaimstatusThe status of the resource instance.code
Claim_statusExtensions for statusElement
ClaimtypeThe category of claim, e.g. oral, pharmacy, vision, institutional, professional.CodeableConcept
ClaimsubTypeA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.CodeableConcept
ClaimuseA 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_useExtensions for useElement
ClaimpatientThe 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
ClaimbillablePeriodThe period for which charges are being submitted.Period
ClaimcreatedThe date this resource was created.dateTime
Claim_createdExtensions for createdElement
ClaimentererIndividual who created the claim, predetermination or preauthorization.Reference
ClaiminsurerThe Insurer who is target of the request.Reference
ClaimproviderThe provider which is responsible for the claim, predetermination or preauthorization.Reference
ClaimpriorityThe provider-required urgency of processing the request. Typical values include: stat, routine deferred.CodeableConcept
ClaimfundsReserveA code to indicate whether and for whom funds are to be reserved for future claims.CodeableConcept
relatedOther claims which are related to this claim such as prior submissions or claims for related services or for the same event.Claim_Related
ClaimprescriptionPrescription to support the dispensing of pharmacy, device or vision products.Reference
ClaimoriginalPrescriptionOriginal prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.Reference
ClaimpayeeThe party to be reimbursed for cost of the products and services according to the terms of the policy.Claim_Payee
ClaimreferralA reference to a referral resource.Reference
ClaimfacilityFacility where the services were provided.Reference
ClaimcareTeamThe members of the team who provided the products and services.Claim_CareTeam
ClaimsupportingInfoAdditional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.Claim_SupportingInfo
ClaimdiagnosisInformation about diagnoses relevant to the claim items.Claim_Diagnosis
ClaimprocedureProcedures performed on the patient relevant to the billing items with the claim.Claim_Procedure
ClaiminsuranceFinancial instruments for reimbursement for the health care products and services specified on the claim.Claim_Insurance
ClaimaccidentDetails of an accident which resulted in injuries which required the products and services listed in the claim.Claim_Accident
ClaimitemA 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
ClaimtotalThe total value of the all the items in the claim.Money
ClaimResponseresourceTypeThis is a ClaimResponse resourceClaimResponse
ClaimResponseidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ClaimResponsemetaThe metadata about the resource. 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
ClaimResponseimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ClaimResponselanguageThe base language in which the resource is written.code
ClaimResponse_languageExtensions for languageElement
ClaimResponsetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ClaimResponsecontainedThese 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
ClaimResponseextensionMay be 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
ClaimResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ClaimResponseidentifierA unique identifier assigned to this claim response.Identifier
ClaimResponsestatusThe status of the resource instance.code
ClaimResponse_statusExtensions for statusElement
ClaimResponsetypeA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.CodeableConcept
ClaimResponsesubTypeA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.CodeableConcept
ClaimResponseuseA 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_useExtensions for useElement
ClaimResponsepatientThe 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
ClaimResponsecreatedThe date this resource was created.dateTime
ClaimResponse_createdExtensions for createdElement
ClaimResponseinsurerThe party responsible for authorization, adjudication and reimbursement.Reference
ClaimResponserequestorThe provider which is responsible for the claim, predetermination or preauthorization.Reference
ClaimResponserequestOriginal request resource reference.Reference
ClaimResponseoutcomeThe outcome of the claim, predetermination, or preauthorization processing.code
ClaimResponse_outcomeExtensions for outcomeElement
ClaimResponsedispositionA human readable description of the status of the adjudication.string
ClaimResponse_dispositionExtensions for dispositionElement
ClaimResponsepreAuthRefReference from the Insurer which is used in later communications which refers to this adjudication.string
ClaimResponse_preAuthRefExtensions for preAuthRefElement
ClaimResponsepreAuthPeriodThe time frame during which this authorization is effective.Period
ClaimResponsepayeeTypeType of Party to be reimbursed: subscriber, provider, other.CodeableConcept
ClaimResponseitemA 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
ClaimResponseaddItemThe first-tier service adjudications for payor added product or service lines.ClaimResponse_AddItem
ClaimResponseadjudicationThe adjudication results which are presented at the header level rather than at the line-item or add-item levels.ClaimResponse_Adjudication
ClaimResponsetotalCategorized monetary totals for the adjudication.ClaimResponse_Total
ClaimResponsepaymentPayment details for the adjudication of the claim.ClaimResponse_Payment
ClaimResponsefundsReserveA code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.CodeableConcept
ClaimResponseformCodeA code for the form to be used for printing the content.CodeableConcept
ClaimResponseformThe actual form, by reference or inclusion, for printing the content or an EOB.Attachment
ClaimResponseprocessNoteA note that describes or explains adjudication results in a human readable form.ClaimResponse_ProcessNote
ClaimResponsecommunicationRequestRequest for additional supporting or authorizing information.Reference
ClaimResponseinsuranceFinancial instruments for reimbursement for the health care products and services specified on the claim.ClaimResponse_Insurance
ClaimResponseerrorErrors encountered during the processing of the adjudication.ClaimResponse_Error
ClaimResponse_AddItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_AddItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AddItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AddItemitemSequenceClaim items which this service line is intended to replace.positiveInt
ClaimResponse_AddItem_itemSequenceExtensions for itemSequenceElement
ClaimResponse_AddItemdetailSequenceThe sequence number of the details within the claim item which this line is intended to replace.positiveInt
ClaimResponse_AddItem_detailSequenceExtensions for detailSequenceElement
ClaimResponse_AddItemsubdetailSequenceThe sequence number of the sub-details within the details within the claim item which this line is intended to replace.positiveInt
ClaimResponse_AddItem_subdetailSequenceExtensions for subdetailSequenceElement
ClaimResponse_AddItemproviderThe providers who are authorized for the services rendered to the patient.Reference
ClaimResponse_AddItemproductOrServiceWhen 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_AddItemmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ClaimResponse_AddItemprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
ClaimResponse_AddItemservicedDateThe date or dates when the service or product was supplied, performed or completed.notDefined
ClaimResponse_AddItem_servicedDateExtensions for servicedDateElement
ClaimResponse_AddItemservicedPeriodThe date or dates when the service or product was supplied, performed or completed.Period
ClaimResponse_AddItemlocationCodeableConceptWhere the product or service was provided.CodeableConcept
ClaimResponse_AddItemlocationAddressWhere the product or service was provided.Address
ClaimResponse_AddItemlocationReferenceWhere the product or service was provided.Reference
ClaimResponse_AddItemquantityThe number of repetitions of a service or product.Quantity
ClaimResponse_AddItemunitPriceIf 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_AddItemfactorA 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_factorExtensions for factorElement
ClaimResponse_AddItemnetThe quantity times the unit price for an additional service or product or charge.Money
ClaimResponse_AddItembodySitePhysical service site on the patient (limb, tooth, etc.).CodeableConcept
ClaimResponse_AddItemsubSiteA region or surface of the bodySite, e.g. limb region or tooth surface(s).CodeableConcept
ClaimResponse_AddItemnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ClaimResponse_AddItem_noteNumberExtensions for noteNumberElement
ClaimResponse_AddItemadjudicationThe adjudication results.ClaimResponse_Adjudication
ClaimResponse_AddItemdetailThe second-tier service adjudications for payor added services.ClaimResponse_Detail1
ClaimResponse_AdjudicationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_AdjudicationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AdjudicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AdjudicationcategoryA 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_AdjudicationreasonA code supporting the understanding of the adjudication result and explaining variance from expected amount.CodeableConcept
ClaimResponse_AdjudicationamountMonetary amount associated with the category.Money
ClaimResponse_AdjudicationvalueA non-monetary value associated with the category. Mutually exclusive to the amount element above.decimal
ClaimResponse_Adjudication_valueExtensions for valueElement
ClaimResponse_DetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_DetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DetaildetailSequenceA number to uniquely reference the claim detail entry.positiveInt
ClaimResponse_Detail_detailSequenceExtensions for detailSequenceElement
ClaimResponse_DetailnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ClaimResponse_Detail_noteNumberExtensions for noteNumberElement
ClaimResponse_DetailadjudicationThe adjudication results.ClaimResponse_Adjudication
ClaimResponse_DetailsubDetailA sub-detail adjudication of a simple product or service.ClaimResponse_SubDetail
ClaimResponse_Detail1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_Detail1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Detail1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Detail1productOrServiceWhen 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_Detail1modifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ClaimResponse_Detail1quantityThe number of repetitions of a service or product.Quantity
ClaimResponse_Detail1unitPriceIf 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_Detail1factorA 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_factorExtensions for factorElement
ClaimResponse_Detail1netThe quantity times the unit price for an additional service or product or charge.Money
ClaimResponse_Detail1noteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ClaimResponse_Detail1_noteNumberExtensions for noteNumberElement
ClaimResponse_Detail1adjudicationThe adjudication results.ClaimResponse_Adjudication
ClaimResponse_Detail1subDetailThe third-tier service adjudications for payor added services.ClaimResponse_SubDetail1
ClaimResponse_ErroridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_ErrorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ErrormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ErroritemSequenceThe 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_itemSequenceExtensions for itemSequenceElement
ClaimResponse_ErrordetailSequenceThe 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_detailSequenceExtensions for detailSequenceElement
ClaimResponse_ErrorsubDetailSequenceThe 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_subDetailSequenceExtensions for subDetailSequenceElement
ClaimResponse_ErrorcodeAn error code, from a specified code system, which details why the claim could not be adjudicated.CodeableConcept
ClaimResponse_InsuranceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_InsuranceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InsurancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InsurancesequenceA number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.positiveInt
ClaimResponse_Insurance_sequenceExtensions for sequenceElement
ClaimResponse_InsurancefocalA flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.boolean
ClaimResponse_Insurance_focalExtensions for focalElement
ClaimResponse_InsurancecoverageReference 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_InsurancebusinessArrangementA business agreement number established between the provider and the insurer for special business processing purposes.string
ClaimResponse_Insurance_businessArrangementExtensions for businessArrangementElement
ClaimResponse_InsuranceclaimResponseThe result of the adjudication of the line items for the Coverage specified in this insurance.Reference
ClaimResponse_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemitemSequenceA number to uniquely reference the claim item entries.positiveInt
ClaimResponse_Item_itemSequenceExtensions for itemSequenceElement
ClaimResponse_ItemnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ClaimResponse_Item_noteNumberExtensions for noteNumberElement
ClaimResponse_ItemadjudicationIf 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_ItemdetailA claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.ClaimResponse_Detail
ClaimResponse_PaymentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_PaymentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PaymentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PaymenttypeWhether this represents partial or complete payment of the benefits payable.CodeableConcept
ClaimResponse_PaymentadjustmentTotal amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.Money
ClaimResponse_PaymentadjustmentReasonReason for the payment adjustment.CodeableConcept
ClaimResponse_PaymentdateEstimated date the payment will be issued or the actual issue date of payment.date
ClaimResponse_Payment_dateExtensions for dateElement
ClaimResponse_PaymentamountBenefits payable less any payment adjustment.Money
ClaimResponse_PaymentidentifierIssuer's unique identifier for the payment instrument.Identifier
ClaimResponse_ProcessNoteidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_ProcessNoteextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProcessNotemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcessNotenumberA number to uniquely identify a note entry.positiveInt
ClaimResponse_ProcessNote_numberExtensions for numberElement
ClaimResponse_ProcessNotetypeThe business purpose of the note text.enum values:
display
print
printoper
ClaimResponse_ProcessNote_typeExtensions for typeElement
ClaimResponse_ProcessNotetextThe explanation or description associated with the processing.string
ClaimResponse_ProcessNote_textExtensions for textElement
ClaimResponse_ProcessNotelanguageA code to define the language used in the text of the note.CodeableConcept
ClaimResponse_SubDetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_SubDetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubDetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubDetailsubDetailSequenceA number to uniquely reference the claim sub-detail entry.positiveInt
ClaimResponse_SubDetail_subDetailSequenceExtensions for subDetailSequenceElement
ClaimResponse_SubDetailnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ClaimResponse_SubDetail_noteNumberExtensions for noteNumberElement
ClaimResponse_SubDetailadjudicationThe adjudication results.ClaimResponse_Adjudication
ClaimResponse_SubDetail1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_SubDetail1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubDetail1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubDetail1productOrServiceWhen 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_SubDetail1modifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ClaimResponse_SubDetail1quantityThe number of repetitions of a service or product.Quantity
ClaimResponse_SubDetail1unitPriceIf 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_SubDetail1factorA 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_factorExtensions for factorElement
ClaimResponse_SubDetail1netThe quantity times the unit price for an additional service or product or charge.Money
ClaimResponse_SubDetail1noteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ClaimResponse_SubDetail1_noteNumberExtensions for noteNumberElement
ClaimResponse_SubDetail1adjudicationThe adjudication results.ClaimResponse_Adjudication
ClaimResponse_TotalidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClaimResponse_TotalextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TotalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TotalcategoryA 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_TotalamountMonetary total amount associated with the category.Money
Claim_AccidentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_AccidentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AccidentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AccidentdateDate of an accident event related to the products and services contained in the claim.date
Claim_Accident_dateExtensions for dateElement
Claim_AccidenttypeThe type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.CodeableConcept
Claim_AccidentlocationAddressThe physical location of the accident event.Address
Claim_AccidentlocationReferenceThe physical location of the accident event.Reference
Claim_CareTeamidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_CareTeamextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CareTeammodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CareTeamsequenceA number to uniquely identify care team entries.positiveInt
Claim_CareTeam_sequenceExtensions for sequenceElement
Claim_CareTeamproviderMember of the team who provided the product or service.Reference
Claim_CareTeamresponsibleThe party who is billing and/or responsible for the claimed products or services.boolean
Claim_CareTeam_responsibleExtensions for responsibleElement
Claim_CareTeamroleThe lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.CodeableConcept
Claim_CareTeamqualificationThe qualification of the practitioner which is applicable for this service.CodeableConcept
Claim_DetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_DetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DetailsequenceA number to uniquely identify item entries.positiveInt
Claim_Detail_sequenceExtensions for sequenceElement
Claim_DetailrevenueThe type of revenue or cost center providing the product and/or service.CodeableConcept
Claim_DetailcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
Claim_DetailproductOrServiceWhen 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_DetailmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
Claim_DetailprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
Claim_DetailquantityThe number of repetitions of a service or product.Quantity
Claim_DetailunitPriceIf 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_DetailfactorA 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_factorExtensions for factorElement
Claim_DetailnetThe quantity times the unit price for an additional service or product or charge.Money
Claim_DetailudiUnique Device Identifiers associated with this line item.Reference
Claim_DetailsubDetailA claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.Claim_SubDetail
Claim_DiagnosisidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_DiagnosisextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DiagnosismodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DiagnosissequenceA number to uniquely identify diagnosis entries.positiveInt
Claim_Diagnosis_sequenceExtensions for sequenceElement
Claim_DiagnosisdiagnosisCodeableConceptThe nature of illness or problem in a coded form or as a reference to an external defined Condition.CodeableConcept
Claim_DiagnosisdiagnosisReferenceThe nature of illness or problem in a coded form or as a reference to an external defined Condition.Reference
Claim_DiagnosistypeWhen the condition was observed or the relative ranking.CodeableConcept
Claim_DiagnosisonAdmissionIndication of whether the diagnosis was present on admission to a facility.CodeableConcept
Claim_DiagnosispackageCodeA 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_InsuranceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_InsuranceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InsurancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InsurancesequenceA number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.positiveInt
Claim_Insurance_sequenceExtensions for sequenceElement
Claim_InsurancefocalA flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.boolean
Claim_Insurance_focalExtensions for focalElement
Claim_InsuranceidentifierThe business identifier to be used when the claim is sent for adjudication against this insurance policy.Identifier
Claim_InsurancecoverageReference 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_InsurancebusinessArrangementA business agreement number established between the provider and the insurer for special business processing purposes.string
Claim_Insurance_businessArrangementExtensions for businessArrangementElement
Claim_InsurancepreAuthRefReference 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_preAuthRefExtensions for preAuthRefElement
Claim_InsuranceclaimResponseThe result of the adjudication of the line items for the Coverage specified in this insurance.Reference
Claim_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemsequenceA number to uniquely identify item entries.positiveInt
Claim_Item_sequenceExtensions for sequenceElement
Claim_ItemcareTeamSequenceCareTeam members related to this service or product.positiveInt
Claim_Item_careTeamSequenceExtensions for careTeamSequenceElement
Claim_ItemdiagnosisSequenceDiagnosis applicable for this service or product.positiveInt
Claim_Item_diagnosisSequenceExtensions for diagnosisSequenceElement
Claim_ItemprocedureSequenceProcedures applicable for this service or product.positiveInt
Claim_Item_procedureSequenceExtensions for procedureSequenceElement
Claim_IteminformationSequenceExceptions, special conditions and supporting information applicable for this service or product.positiveInt
Claim_Item_informationSequenceExtensions for informationSequenceElement
Claim_ItemrevenueThe type of revenue or cost center providing the product and/or service.CodeableConcept
Claim_ItemcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
Claim_ItemproductOrServiceWhen 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_ItemmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
Claim_ItemprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
Claim_ItemservicedDateThe date or dates when the service or product was supplied, performed or completed.notDefined
Claim_Item_servicedDateExtensions for servicedDateElement
Claim_ItemservicedPeriodThe date or dates when the service or product was supplied, performed or completed.Period
Claim_ItemlocationCodeableConceptWhere the product or service was provided.CodeableConcept
Claim_ItemlocationAddressWhere the product or service was provided.Address
Claim_ItemlocationReferenceWhere the product or service was provided.Reference
Claim_ItemquantityThe number of repetitions of a service or product.Quantity
Claim_ItemunitPriceIf 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_ItemfactorA 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_factorExtensions for factorElement
Claim_ItemnetThe quantity times the unit price for an additional service or product or charge.Money
Claim_ItemudiUnique Device Identifiers associated with this line item.Reference
Claim_ItembodySitePhysical service site on the patient (limb, tooth, etc.).CodeableConcept
Claim_ItemsubSiteA region or surface of the bodySite, e.g. limb region or tooth surface(s).CodeableConcept
Claim_ItemencounterThe Encounters during which this Claim was created or to which the creation of this record is tightly associated.Reference
Claim_ItemdetailA claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.Claim_Detail
Claim_PayeeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_PayeeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PayeemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PayeetypeType of Party to be reimbursed: subscriber, provider, other.CodeableConcept
Claim_PayeepartyReference to the individual or organization to whom any payment will be made.Reference
Claim_ProcedureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_ProcedureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProceduremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProceduresequenceA number to uniquely identify procedure entries.positiveInt
Claim_Procedure_sequenceExtensions for sequenceElement
Claim_ProceduretypeWhen the condition was observed or the relative ranking.CodeableConcept
Claim_ProceduredateDate and optionally time the procedure was performed.dateTime
Claim_Procedure_dateExtensions for dateElement
Claim_ProcedureprocedureCodeableConceptThe code or reference to a Procedure resource which identifies the clinical intervention performed.CodeableConcept
Claim_ProcedureprocedureReferenceThe code or reference to a Procedure resource which identifies the clinical intervention performed.Reference
Claim_ProcedureudiUnique Device Identifiers associated with this line item.Reference
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
claimReference to a related claim.Reference
relationshipA code to convey how the claims are related.CodeableConcept
referenceAn alternate organizational reference to the case or file to which this particular claim pertains.Identifier
Claim_SubDetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_SubDetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubDetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubDetailsequenceA number to uniquely identify item entries.positiveInt
Claim_SubDetail_sequenceExtensions for sequenceElement
Claim_SubDetailrevenueThe type of revenue or cost center providing the product and/or service.CodeableConcept
Claim_SubDetailcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
Claim_SubDetailproductOrServiceWhen 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_SubDetailmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
Claim_SubDetailprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
Claim_SubDetailquantityThe number of repetitions of a service or product.Quantity
Claim_SubDetailunitPriceIf 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_SubDetailfactorA 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_factorExtensions for factorElement
Claim_SubDetailnetThe quantity times the unit price for an additional service or product or charge.Money
Claim_SubDetailudiUnique Device Identifiers associated with this line item.Reference
Claim_SupportingInfoidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Claim_SupportingInfoextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SupportingInfomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SupportingInfosequenceA number to uniquely identify supporting information entries.positiveInt
Claim_SupportingInfo_sequenceExtensions for sequenceElement
Claim_SupportingInfocategoryThe general class of the information supplied: information; exception; accident, employment; onset, etc.CodeableConcept
Claim_SupportingInfocodeSystem and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.CodeableConcept
Claim_SupportingInfotimingDateThe date when or period to which this information refers.notDefined
Claim_SupportingInfo_timingDateExtensions for timingDateElement
Claim_SupportingInfotimingPeriodThe date when or period to which this information refers.Period
Claim_SupportingInfovalueBooleanAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.notDefined
Claim_SupportingInfo_valueBooleanExtensions for valueBooleanElement
Claim_SupportingInfovalueStringAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.notDefined
Claim_SupportingInfo_valueStringExtensions for valueStringElement
Claim_SupportingInfovalueQuantityAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Quantity
Claim_SupportingInfovalueAttachmentAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Attachment
Claim_SupportingInfovalueReferenceAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Reference
Claim_SupportingInforeasonProvides the reason in the situation where a reason code is required in addition to the content.CodeableConcept
ClinicalImpressionresourceTypeThis is a ClinicalImpression resourceClinicalImpression
ClinicalImpressionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ClinicalImpressionmetaThe metadata about the resource. 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
ClinicalImpressionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ClinicalImpressionlanguageThe base language in which the resource is written.code
ClinicalImpression_languageExtensions for languageElement
ClinicalImpressiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ClinicalImpressioncontainedThese 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
ClinicalImpressionextensionMay be 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
ClinicalImpressionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ClinicalImpressionidentifierBusiness 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
ClinicalImpressionstatusIdentifies the workflow status of the assessment.code
ClinicalImpression_statusExtensions for statusElement
ClinicalImpressionstatusReasonCaptures the reason for the current state of the ClinicalImpression.CodeableConcept
ClinicalImpressiondescriptionA summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.string
ClinicalImpression_descriptionExtensions for descriptionElement
ClinicalImpressionsubjectThe patient or group of individuals assessed as part of this record.Reference
ClinicalImpressionencounterThe Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.Reference
ClinicalImpressioneffectiveDateTimeThe point in time or period over which the subject was assessed.notDefined
ClinicalImpression_effectiveDateTimeExtensions for effectiveDateTimeElement
ClinicalImpressioneffectivePeriodThe point in time or period over which the subject was assessed.Period
ClinicalImpressiondateIndicates when the documentation of the assessment was complete.dateTime
ClinicalImpression_dateExtensions for dateElement
ClinicalImpressionperformerThe clinician performing the assessment.Reference
ClinicalImpressionpreviousA 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
ClinicalImpressionproblemA list of the relevant problems/conditions for a patient.Reference
ClinicalImpressionprotocolReference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.uri
ClinicalImpression_protocolExtensions for protocolElement
ClinicalImpressionsummaryA text summary of the investigations and the diagnosis.string
ClinicalImpression_summaryExtensions for summaryElement
ClinicalImpressionfindingSpecific findings or diagnoses that were considered likely or relevant to ongoing treatment.ClinicalImpression_Finding
ClinicalImpressionprognosisCodeableConceptEstimate of likely outcome.CodeableConcept
ClinicalImpressionprognosisReferenceRiskAssessment expressing likely outcome.Reference
ClinicalImpressionsupportingInfoInformation supporting the clinical impression, which can contain investigation results.Reference
ClinicalImpressionnoteCommentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.Annotation
ClinicalImpression_FindingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClinicalImpression_FindingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FindingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FindingitemSpecific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.CodeableReference
ClinicalImpression_FindingbasisWhich investigations support finding or diagnosis.string
ClinicalImpression_Finding_basisExtensions for basisElement
ClinicalUseIssueresourceTypeThis is a ClinicalUseIssue resourceClinicalUseIssue
ClinicalUseIssueidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ClinicalUseIssuemetaThe metadata about the resource. 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
ClinicalUseIssueimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
ClinicalUseIssue_implicitRulesExtensions for implicitRulesElement
ClinicalUseIssuelanguageThe base language in which the resource is written.code
ClinicalUseIssue_languageExtensions for languageElement
ClinicalUseIssuetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ClinicalUseIssuecontainedThese 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
ClinicalUseIssueextensionMay be 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
ClinicalUseIssuemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ClinicalUseIssueidentifierBusiness identifier for this issue.Identifier
ClinicalUseIssuetypeindication | contraindication | interaction | undesirable-effect | warning.enum values:
indication
contraindication
interaction
undesirable-effect
warning
ClinicalUseIssue_typeExtensions for typeElement
ClinicalUseIssuecategoryA categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects Ability to Drive and Use Machines".CodeableConcept
ClinicalUseIssuesubjectThe medication or procedure for which this is an indication.Reference
ClinicalUseIssuestatusGeneral description.CodeableConcept
ClinicalUseIssuedescriptionGeneral description.markdown
ClinicalUseIssue_descriptionExtensions for descriptionElement
ClinicalUseIssuecontraindicationSpecifics for when this is a contraindication.ClinicalUseIssue_Contraindication
ClinicalUseIssueindicationSpecifics for when this is an indication.ClinicalUseIssue_Indication
ClinicalUseIssueinteractionSpecifics for when this is an interaction.ClinicalUseIssue_Interaction
ClinicalUseIssuepopulationThe population group to which this applies.Population
ClinicalUseIssueundesirableEffectDescribe the undesirable effects of the medicinal product.ClinicalUseIssue_UndesirableEffect
ClinicalUseIssue_ContraindicationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClinicalUseIssue_ContraindicationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ClinicalUseIssue_ContraindicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ClinicalUseIssue_ContraindicationdiseaseSymptomProcedureThe situation that is being documented as contraindicating against this item.CodeableConcept
ClinicalUseIssue_ContraindicationdiseaseStatusThe status of the disease or symptom for the contraindication.CodeableConcept
ClinicalUseIssue_ContraindicationcomorbidityA comorbidity (concurrent condition) or coinfection.CodeableConcept
ClinicalUseIssue_ContraindicationindicationThe indication which this is a contraidication for.Reference
ClinicalUseIssue_ContraindicationotherTherapyInformation about the use of the medicinal product in relation to other therapies described as part of the indication.ClinicalUseIssue_OtherTherapy
ClinicalUseIssue_IndicationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClinicalUseIssue_IndicationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ClinicalUseIssue_IndicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ClinicalUseIssue_IndicationdiseaseSymptomProcedureThe situation that is being documented as an indicaton for this item.CodeableConcept
ClinicalUseIssue_IndicationdiseaseStatusThe status of the disease or symptom for the indication.CodeableConcept
ClinicalUseIssue_IndicationcomorbidityA comorbidity (concurrent condition) or coinfection as part of the indication.CodeableConcept
ClinicalUseIssue_IndicationintendedEffectFor an indication - the intended effect, aim or strategy to be achieved.CodeableConcept
ClinicalUseIssue_IndicationdurationFor an indication - timing or duration information.Quantity
ClinicalUseIssue_IndicationundesirableEffectFor an indicaton - the specific undesirable effects of the medicinal product.Reference
ClinicalUseIssue_IndicationotherTherapyInformation about the use of the medicinal product in relation to other therapies described as part of the contraindication.ClinicalUseIssue_OtherTherapy
ClinicalUseIssue_InteractantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClinicalUseIssue_InteractantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ClinicalUseIssue_InteractantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ClinicalUseIssue_InteractantitemReferenceThe specific medication, food or laboratory test that interacts.Reference
ClinicalUseIssue_InteractantitemCodeableConceptThe specific medication, food or laboratory test that interacts.CodeableConcept
ClinicalUseIssue_InteractionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClinicalUseIssue_InteractionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ClinicalUseIssue_InteractionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ClinicalUseIssue_InteractioninteractantThe specific medication, food or laboratory test that interacts.ClinicalUseIssue_Interactant
ClinicalUseIssue_InteractiontypeThe type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.CodeableConcept
ClinicalUseIssue_InteractioneffectThe effect of the interaction, for example "reduced gastric absorption of primary medication".CodeableConcept
ClinicalUseIssue_InteractionincidenceThe incidence of the interaction, e.g. theoretical, observed.CodeableConcept
ClinicalUseIssue_InteractionmanagementActions for managing the interaction.CodeableConcept
ClinicalUseIssue_OtherTherapyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClinicalUseIssue_OtherTherapyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ClinicalUseIssue_OtherTherapymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ClinicalUseIssue_OtherTherapytherapyRelationshipTypeThe type of relationship between the medicinal product indication or contraindication and another therapy.CodeableConcept
ClinicalUseIssue_OtherTherapymedicationCodeableConceptReference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.CodeableConcept
ClinicalUseIssue_OtherTherapymedicationReferenceReference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.Reference
ClinicalUseIssue_UndesirableEffectidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ClinicalUseIssue_UndesirableEffectextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ClinicalUseIssue_UndesirableEffectmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ClinicalUseIssue_UndesirableEffectsymptomConditionEffectThe situation in which the undesirable effect may manifest.CodeableConcept
ClinicalUseIssue_UndesirableEffectclassificationHigh level classification of the effect.CodeableConcept
ClinicalUseIssue_UndesirableEffectfrequencyOfOccurrenceHow often the effect is seen.CodeableConcept
CodeSystemresourceTypeThis is a CodeSystem resourceCodeSystem
CodeSystemidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CodeSystemmetaThe metadata about the resource. 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
CodeSystemimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CodeSystemlanguageThe base language in which the resource is written.code
CodeSystem_languageExtensions for languageElement
CodeSystemtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CodeSystemcontainedThese 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
CodeSystemextensionMay be 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
CodeSystemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CodeSystemurlAn 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_urlExtensions for urlElement
CodeSystemidentifierA 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
CodeSystemversionThe 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_versionExtensions for versionElement
CodeSystemnameA 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_nameExtensions for nameElement
CodeSystemtitleA short, descriptive, user-friendly title for the code system.string
CodeSystem_titleExtensions for titleElement
CodeSystemstatusThe date (and optionally time) when the code system resource was created or revised.enum values:
draft
active
retired
unknown
CodeSystem_statusExtensions for statusElement
CodeSystemexperimentalA 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_experimentalExtensions for experimentalElement
CodeSystemdateThe 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_dateExtensions for dateElement
CodeSystempublisherThe name of the organization or individual that published the code system.string
CodeSystem_publisherExtensions for publisherElement
CodeSystemcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
CodeSystemdescriptionA free text natural language description of the code system from a consumer's perspective.markdown
CodeSystem_descriptionExtensions for descriptionElement
CodeSystemuseContextThe 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
CodeSystemjurisdictionA legal or geographic region in which the code system is intended to be used.CodeableConcept
CodeSystempurposeExplanation of why this code system is needed and why it has been designed as it has.markdown
CodeSystem_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
CodeSystemcaseSensitiveIf code comparison is case sensitive when codes within this system are compared to each other.boolean
CodeSystem_caseSensitiveExtensions for caseSensitiveElement
CodeSystemvalueSetCanonical reference to the value set that contains the entire code system.canonical
CodeSystemhierarchyMeaningThe meaning of the hierarchy of concepts as represented in this resource.enum values:
grouped-by
is-a
part-of
classified-with
CodeSystem_hierarchyMeaningExtensions for hierarchyMeaningElement
CodeSystemcompositionalThe code system defines a compositional (post-coordination) grammar.boolean
CodeSystem_compositionalExtensions for compositionalElement
CodeSystemversionNeededThis 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_versionNeededExtensions for versionNeededElement
CodeSystemcontentThe 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_contentExtensions for contentElement
CodeSystemsupplementsThe canonical URL of the code system that this code system supplement is adding designations and properties to.canonical
CodeSystemcountThe 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_countExtensions for countElement
CodeSystemfilterA filter that can be used in a value set compose statement when selecting concepts using a filter.CodeSystem_Filter
CodeSystempropertyA property defines an additional slot through which additional information can be provided about a concept.CodeSystem_Property
CodeSystemconceptConcepts 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_ConceptidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodeSystem_ConceptextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ConceptmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ConceptcodeA code - a text symbol - that uniquely identifies the concept within the code system.code
CodeSystem_Concept_codeExtensions for codeElement
CodeSystem_ConceptdisplayA human readable string that is the recommended default way to present this concept to a user.string
CodeSystem_Concept_displayExtensions for displayElement
CodeSystem_ConceptdefinitionThe 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_definitionExtensions for definitionElement
CodeSystem_ConceptdesignationAdditional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.CodeSystem_Designation
CodeSystem_ConceptpropertyA property value for this concept.CodeSystem_Property1
CodeSystem_ConceptconceptDefines 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_DesignationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodeSystem_DesignationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DesignationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DesignationlanguageThe language this designation is defined for.code
CodeSystem_Designation_languageExtensions for languageElement
CodeSystem_DesignationuseA code that details how this designation would be used.Coding
CodeSystem_DesignationvalueThe text value for this designation.string
CodeSystem_Designation_valueExtensions for valueElement
CodeSystem_FilteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodeSystem_FilterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FiltermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FiltercodeThe code that identifies this filter when it is used as a filter in [[[ValueSet]]].compose.include.filter.code
CodeSystem_Filter_codeExtensions for codeElement
CodeSystem_FilterdescriptionA description of how or why the filter is used.string
CodeSystem_Filter_descriptionExtensions for descriptionElement
CodeSystem_FilteroperatorA list of operators that can be used with the filter.code
CodeSystem_Filter_operatorExtensions for operatorElement
CodeSystem_FiltervalueA description of what the value for the filter should be.string
CodeSystem_Filter_valueExtensions for valueElement
CodeSystem_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodeSystem_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PropertycodeA 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_codeExtensions for codeElement
CodeSystem_PropertyuriReference 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_uriExtensions for uriElement
CodeSystem_PropertydescriptionA description of the property- why it is defined, and how its value might be used.string
CodeSystem_Property_descriptionExtensions for descriptionElement
CodeSystem_PropertytypeThe 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_typeExtensions for typeElement
CodeSystem_Property1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodeSystem_Property1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Property1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Property1codeA code that is a reference to CodeSystem.property.code.code
CodeSystem_Property1_codeExtensions for codeElement
CodeSystem_Property1valueCodeThe value of this property.notDefined
CodeSystem_Property1_valueCodeExtensions for valueCodeElement
CodeSystem_Property1valueCodingThe value of this property.Coding
CodeSystem_Property1valueStringThe value of this property.notDefined
CodeSystem_Property1_valueStringExtensions for valueStringElement
CodeSystem_Property1valueIntegerThe value of this property.notDefined
CodeSystem_Property1_valueIntegerExtensions for valueIntegerElement
CodeSystem_Property1valueBooleanThe value of this property.notDefined
CodeSystem_Property1_valueBooleanExtensions for valueBooleanElement
CodeSystem_Property1valueDateTimeThe value of this property.notDefined
CodeSystem_Property1_valueDateTimeExtensions for valueDateTimeElement
CodeSystem_Property1valueDecimalThe value of this property.notDefined
CodeSystem_Property1_valueDecimalExtensions for valueDecimalElement
CodeableConceptidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodeableConceptextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CodeableConceptcodingA reference to a code defined by a terminology system.Coding
CodeableConcepttextA 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_textExtensions for textElement
CodeableReferenceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodeableReferenceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CodeableReferenceconceptA reference to a concept - e.g. the information is identified by it's general classto the degree of precision found in the terminology.CodeableConcept
CodeableReferencereferenceA reference to a resource the provides exact details about the information being referenced.Reference
CodingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CodingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CodingsystemThe identification of the code system that defines the meaning of the symbol in the code.uri
Coding_systemExtensions for systemElement
CodingversionThe 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_versionExtensions for versionElement
CodingcodeA 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_codeExtensions for codeElement
CodingdisplayA representation of the meaning of the code in the system, following the rules of the system.string
Coding_displayExtensions for displayElement
CodinguserSelectedIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).boolean
Coding_userSelectedExtensions for userSelectedElement
CommunicationresourceTypeThis is a Communication resourceCommunication
CommunicationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CommunicationmetaThe metadata about the resource. 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
CommunicationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CommunicationlanguageThe base language in which the resource is written.code
Communication_languageExtensions for languageElement
CommunicationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CommunicationcontainedThese 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
CommunicationextensionMay be 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
CommunicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CommunicationidentifierBusiness 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
CommunicationinstantiatesCanonicalThe 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
CommunicationinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
CommunicationbasedOnAn order, proposal or plan fulfilled in whole or in part by this Communication.Reference
CommunicationpartOfA larger event (e.g. Communication, Procedure) of which this particular communication is a component or step.Reference
CommunicationinResponseToPrior communication that this communication is in response to.Reference
CommunicationstatusThe status of the transmission.code
Communication_statusExtensions for statusElement
CommunicationstatusReasonCaptures the reason for the current state of the Communication.CodeableConcept
CommunicationcategoryThe type of message conveyed such as alert, notification, reminder, instruction, etc.CodeableConcept
CommunicationpriorityCharacterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.code
Communication_priorityExtensions for priorityElement
CommunicationmediumA channel that was used for this communication (e.g. email, fax).CodeableConcept
CommunicationsubjectThe patient or group that was the focus of this communication.Reference
CommunicationtopicDescription of the purpose/content, similar to a subject line in an email.CodeableConcept
CommunicationaboutOther resources that pertain to this communication and to which this communication should be associated.Reference
CommunicationencounterThe Encounter during which this Communication was created or to which the creation of this record is tightly associated.Reference
CommunicationsentThe time when this communication was sent.dateTime
Communication_sentExtensions for sentElement
CommunicationreceivedThe time when this communication arrived at the destination.dateTime
Communication_receivedExtensions for receivedElement
CommunicationrecipientThe entity (e.g. person, organization, clinical information system, care team or device) which is the target of the communication.Reference
CommunicationsenderThe entity (e.g. person, organization, clinical information system, or device) which is the source of the communication.Reference
CommunicationreasonThe reason or justification for the communication.CodeableReference
CommunicationpayloadText, attachment(s), or resource(s) that was communicated to the recipient.Communication_Payload
CommunicationnoteAdditional notes or commentary about the communication by the sender, receiver or other interested parties.Annotation
CommunicationRequestresourceTypeThis is a CommunicationRequest resourceCommunicationRequest
CommunicationRequestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CommunicationRequestmetaThe metadata about the resource. 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
CommunicationRequestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CommunicationRequestlanguageThe base language in which the resource is written.code
CommunicationRequest_languageExtensions for languageElement
CommunicationRequesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CommunicationRequestcontainedThese 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
CommunicationRequestextensionMay be 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
CommunicationRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CommunicationRequestidentifierBusiness 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
CommunicationRequestbasedOnA plan or proposal that is fulfilled in whole or in part by this request.Reference
CommunicationRequestreplacesCompleted or terminated request(s) whose function is taken by this new request.Reference
CommunicationRequestgroupIdentifierA 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
CommunicationRequeststatusThe status of the proposal or order.code
CommunicationRequest_statusExtensions for statusElement
CommunicationRequeststatusReasonCaptures the reason for the current state of the CommunicationRequest.CodeableConcept
CommunicationRequestcategoryThe type of message to be sent such as alert, notification, reminder, instruction, etc.CodeableConcept
CommunicationRequestpriorityCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.code
CommunicationRequest_priorityExtensions for priorityElement
CommunicationRequestdoNotPerformIf true indicates that the CommunicationRequest is asking for the specified action to *not* occur.boolean
CommunicationRequest_doNotPerformExtensions for doNotPerformElement
CommunicationRequestmediumA channel that was used for this communication (e.g. email, fax).CodeableConcept
CommunicationRequestsubjectThe patient or group that is the focus of this communication request.Reference
CommunicationRequestaboutOther resources that pertain to this communication request and to which this communication request should be associated.Reference
CommunicationRequestencounterThe Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.Reference
CommunicationRequestpayloadText, attachment(s), or resource(s) to be communicated to the recipient.CommunicationRequest_Payload
CommunicationRequestoccurrenceDateTimeThe time when this communication is to occur.notDefined
CommunicationRequest_occurrenceDateTimeExtensions for occurrenceDateTimeElement
CommunicationRequestoccurrencePeriodThe time when this communication is to occur.Period
CommunicationRequestauthoredOnFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.dateTime
CommunicationRequest_authoredOnExtensions for authoredOnElement
CommunicationRequestrequesterThe device, individual, or organization who asks for the information to be shared.Reference
CommunicationRequestrecipientThe entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.Reference
CommunicationRequestinformationProviderThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.Reference
CommunicationRequestreasonDescribes why the request is being made in coded or textual form.CodeableReference
CommunicationRequestnoteComments made about the request by the requester, sender, recipient, subject or other participants.Annotation
CommunicationRequest_PayloadidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CommunicationRequest_PayloadextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PayloadmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PayloadcontentAttachmentThe communicated content (or for multi-part communications, one portion of the communication).Attachment
CommunicationRequest_PayloadcontentReferenceThe communicated content (or for multi-part communications, one portion of the communication).Reference
CommunicationRequest_PayloadcontentCodeableConceptThe communicated content (or for multi-part communications, one portion of the communication).CodeableConcept
Communication_PayloadidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Communication_PayloadextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PayloadmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PayloadcontentAttachmentA communicated content (or for multi-part communications, one portion of the communication).Attachment
Communication_PayloadcontentReferenceA communicated content (or for multi-part communications, one portion of the communication).Reference
Communication_PayloadcontentCodeableConceptA communicated content (or for multi-part communications, one portion of the communication).CodeableConcept
CompartmentDefinitionresourceTypeThis is a CompartmentDefinition resourceCompartmentDefinition
CompartmentDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CompartmentDefinitionmetaThe metadata about the resource. 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
CompartmentDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CompartmentDefinitionlanguageThe base language in which the resource is written.code
CompartmentDefinition_languageExtensions for languageElement
CompartmentDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CompartmentDefinitioncontainedThese 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
CompartmentDefinitionextensionMay be 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
CompartmentDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CompartmentDefinitionurlAn 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_urlExtensions for urlElement
CompartmentDefinitionidentifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
CompartmentDefinitionversionThe 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_versionExtensions for versionElement
CompartmentDefinitionnameA 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_nameExtensions for nameElement
CompartmentDefinitiontitleA short, descriptive, user-friendly title for the {{title}}.string
CompartmentDefinition_titleExtensions for titleElement
CompartmentDefinitionstatusThe status of this compartment definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
CompartmentDefinition_statusExtensions for statusElement
CompartmentDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
CompartmentDefinitiondateThe 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_dateExtensions for dateElement
CompartmentDefinitionpublisherThe name of the organization or individual that published the compartment definition.string
CompartmentDefinition_publisherExtensions for publisherElement
CompartmentDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
CompartmentDefinitiondescriptionA free text natural language description of the compartment definition from a consumer's perspective.markdown
CompartmentDefinition_descriptionExtensions for descriptionElement
CompartmentDefinitionuseContextThe 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
CompartmentDefinitionjurisdictionA legal or geographic region in which the {{title}} is intended to be used.CodeableConcept
CompartmentDefinitionpurposeExplanation of why this compartment definition is needed and why it has been designed as it has.markdown
CompartmentDefinition_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
CompartmentDefinitioncodeWhich compartment this definition describes.enum values:
Patient
Encounter
RelatedPerson
Practitioner
Device
CompartmentDefinition_codeExtensions for codeElement
searchWhether the search syntax is supported,.boolean
_searchExtensions for searchElement
CompartmentDefinitionresourceInformation about how a resource is related to the compartment.CompartmentDefinition_Resource
CompartmentDefinition_ResourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CompartmentDefinition_ResourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ResourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ResourcecodeThe name of a resource supported by the server.code
CompartmentDefinition_Resource_codeExtensions for codeElement
CompartmentDefinition_ResourceparamThe 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_paramExtensions for paramElement
CompartmentDefinition_ResourcedocumentationAdditional documentation about the resource and compartment.string
CompartmentDefinition_Resource_documentationExtensions for documentationElement
CompositionresourceTypeThis is a Composition resourceComposition
CompositionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CompositionmetaThe metadata about the resource. 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
CompositionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CompositionlanguageThe base language in which the resource is written.code
Composition_languageExtensions for languageElement
CompositiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CompositioncontainedThese 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
CompositionextensionMay be 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
CompositionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CompositionidentifierA version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.Identifier
CompositionstatusThe 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_statusExtensions for statusElement
CompositiontypeSpecifies 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
CompositioncategoryA 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
CompositionsubjectWho 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
CompositionencounterDescribes the clinical encounter or type of care this documentation is associated with.Reference
CompositiondateThe composition editing time, when the composition was last logically changed by the author.dateTime
Composition_dateExtensions for dateElement
CompositionauthorIdentifies who is responsible for the information in the composition, not necessarily who typed it in.Reference
CompositiontitleOfficial human-readable label for the composition.string
Composition_titleExtensions for titleElement
CompositionconfidentialityThe code specifying the level of confidentiality of the Composition.code
Composition_confidentialityExtensions for confidentialityElement
CompositionattesterA participant who has attested to the accuracy of the composition/document.Composition_Attester
CompositioncustodianIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.Reference
CompositionrelatesToRelationships that this composition has with other compositions or documents that already exist.Composition_RelatesTo
CompositioneventThe clinical service, such as a colonoscopy or an appendectomy, being documented.Composition_Event
CompositionsectionThe root of the sections that make up the composition.Composition_Section
Composition_AttesteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Composition_AttesterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AttestermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AttestermodeThe type of attestation the authenticator offers.enum values:
personal
professional
legal
official
Composition_Attester_modeExtensions for modeElement
Composition_AttestertimeWhen the composition was attested by the party.dateTime
Composition_Attester_timeExtensions for timeElement
Composition_AttesterpartyWho attested the composition in the specified way.Reference
Composition_EventidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Composition_EventextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EventmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EventcodeThis 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_EventperiodThe 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_EventdetailThe 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_RelatesToidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Composition_RelatesToextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RelatesTomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RelatesTocodeThe type of relationship that this composition has with anther composition or document.code
Composition_RelatesTo_codeExtensions for codeElement
Composition_RelatesTotargetIdentifierThe target composition/document of this relationship.Identifier
Composition_RelatesTotargetReferenceThe target composition/document of this relationship.Reference
Composition_SectionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Composition_SectionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SectionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SectiontitleThe 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_titleExtensions for titleElement
Composition_SectioncodeA code identifying the kind of content contained within the section. This must be consistent with the section title.CodeableConcept
Composition_SectionauthorIdentifies who is responsible for the information in this section, not necessarily who typed it in.Reference
Composition_SectionfocusThe 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_SectiontextA 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_SectionmodeHow 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_modeExtensions for modeElement
Composition_SectionorderedBySpecifies the order applied to the items in the section entries.CodeableConcept
Composition_SectionentryA reference to the actual resource from which the narrative in the section is derived.Reference
Composition_SectionemptyReasonIf the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.CodeableConcept
Composition_SectionsectionA nested sub-section within this section.Composition_Section
ConceptMapresourceTypeThis is a ConceptMap resourceConceptMap
ConceptMapidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ConceptMapmetaThe metadata about the resource. 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
ConceptMapimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ConceptMaplanguageThe base language in which the resource is written.code
ConceptMap_languageExtensions for languageElement
ConceptMaptextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ConceptMapcontainedThese 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
ConceptMapextensionMay be 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
ConceptMapmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ConceptMapurlAn 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_urlExtensions for urlElement
ConceptMapidentifierA 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
ConceptMapversionThe 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_versionExtensions for versionElement
ConceptMapnameA 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_nameExtensions for nameElement
ConceptMaptitleA short, descriptive, user-friendly title for the concept map.string
ConceptMap_titleExtensions for titleElement
ConceptMapstatusThe status of this concept map. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
ConceptMap_statusExtensions for statusElement
ConceptMapexperimentalA 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_experimentalExtensions for experimentalElement
ConceptMapdateThe 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_dateExtensions for dateElement
ConceptMappublisherThe name of the organization or individual that published the concept map.string
ConceptMap_publisherExtensions for publisherElement
ConceptMapcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ConceptMapdescriptionA free text natural language description of the concept map from a consumer's perspective.markdown
ConceptMap_descriptionExtensions for descriptionElement
ConceptMapuseContextThe 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
ConceptMapjurisdictionA legal or geographic region in which the concept map is intended to be used.CodeableConcept
ConceptMappurposeExplanation of why this concept map is needed and why it has been designed as it has.markdown
ConceptMap_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
ConceptMapsourceUriIdentifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.notDefined
ConceptMap_sourceUriExtensions for sourceUriElement
ConceptMapsourceCanonicalIdentifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.notDefined
ConceptMap_sourceCanonicalExtensions for sourceCanonicalElement
ConceptMaptargetUriThe 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_targetUriExtensions for targetUriElement
ConceptMaptargetCanonicalThe 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_targetCanonicalExtensions for targetCanonicalElement
ConceptMapgroupA group of mappings that all have the same source and target system.ConceptMap_Group
ConceptMap_DependsOnidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConceptMap_DependsOnextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DependsOnmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DependsOnpropertyA 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_propertyExtensions for propertyElement
ConceptMap_DependsOnsystemAn 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_DependsOnvalueIdentity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.string
ConceptMap_DependsOn_valueExtensions for valueElement
ConceptMap_DependsOndisplayThe display for the code. The display is only provided to help editors when editing the concept map.string
ConceptMap_DependsOn_displayExtensions for displayElement
ConceptMap_ElementidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConceptMap_ElementextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ElementmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ElementcodeIdentity (code or path) or the element/item being mapped.code
ConceptMap_Element_codeExtensions for codeElement
ConceptMap_ElementdisplayThe display for the code. The display is only provided to help editors when editing the concept map.string
ConceptMap_Element_displayExtensions for displayElement
ConceptMap_ElementnoMapIf noMap = true this indicates that no mapping to a target concept exists for this source concept.boolean
ConceptMap_Element_noMapExtensions for noMapElement
ConceptMap_ElementtargetA concept from the target value set that this concept maps to.ConceptMap_Target
ConceptMap_GroupidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConceptMap_GroupextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GroupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GroupsourceAn absolute URI that identifies the source system where the concepts to be mapped are defined.uri
ConceptMap_Group_sourceExtensions for sourceElement
ConceptMap_GroupsourceVersionThe specific version of the code system, as determined by the code system authority.string
ConceptMap_Group_sourceVersionExtensions for sourceVersionElement
ConceptMap_GrouptargetAn absolute URI that identifies the target system that the concepts will be mapped to.uri
ConceptMap_Group_targetExtensions for targetElement
ConceptMap_GrouptargetVersionThe specific version of the code system, as determined by the code system authority.string
ConceptMap_Group_targetVersionExtensions for targetVersionElement
ConceptMap_GroupelementMappings for an individual concept in the source to one or more concepts in the target.ConceptMap_Element
ConceptMap_GroupunmappedWhat to do when there is no mapping to a target concept from the source concept. This provides the "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to.ConceptMap_Unmapped
ConceptMap_TargetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConceptMap_TargetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TargetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TargetcodeIdentity (code or path) or the element/item that the map refers to.code
ConceptMap_Target_codeExtensions for codeElement
ConceptMap_TargetdisplayThe display for the code. The display is only provided to help editors when editing the concept map.string
ConceptMap_Target_displayExtensions for displayElement
ConceptMap_TargetrelationshipThe relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).enum values:
related-to
equivalent
source-is-narrower-than-target
source-is-broader-than-target
not-related-to
ConceptMap_Target_relationshipExtensions for relationshipElement
ConceptMap_TargetcommentA description of status/issues in mapping that conveys additional information not represented in the structured data.string
ConceptMap_Target_commentExtensions for commentElement
ConceptMap_TargetdependsOnA 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_TargetproductA 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 relationship (e.g., equivalent) cannot be relied on.ConceptMap_DependsOn
ConceptMap_UnmappedidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConceptMap_UnmappedextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_UnmappedmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_UnmappedmodeDefines 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_modeExtensions for modeElement
ConceptMap_UnmappedcodeThe fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.code
ConceptMap_Unmapped_codeExtensions for codeElement
ConceptMap_UnmappeddisplayThe display for the code. The display is only provided to help editors when editing the concept map.string
ConceptMap_Unmapped_displayExtensions for displayElement
ConceptMap_UnmappedurlThe 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
ConditionresourceTypeThis is a Condition resourceCondition
ConditionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ConditionmetaThe metadata about the resource. 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
ConditionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ConditionlanguageThe base language in which the resource is written.code
Condition_languageExtensions for languageElement
ConditiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ConditioncontainedThese 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
ConditionextensionMay be 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
ConditionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ConditionidentifierBusiness 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
ConditionclinicalStatusThe clinical status of the condition.CodeableConcept
ConditionverificationStatusThe verification status to support the clinical status of the condition.CodeableConcept
ConditioncategoryA category assigned to the condition.CodeableConcept
ConditionseverityA subjective assessment of the severity of the condition as evaluated by the clinician.CodeableConcept
ConditioncodeIdentification of the condition, problem or diagnosis.CodeableConcept
ConditionbodySiteThe anatomical location where this condition manifests itself.CodeableConcept
ConditionsubjectIndicates the patient or group who the condition record is associated with.Reference
ConditionencounterThe Encounter during which this Condition was created or to which the creation of this record is tightly associated.Reference
ConditiononsetDateTimeEstimated or actual date or date-time the condition began, in the opinion of the clinician.notDefined
Condition_onsetDateTimeExtensions for onsetDateTimeElement
ConditiononsetAgeEstimated or actual date or date-time the condition began, in the opinion of the clinician.Age
ConditiononsetPeriodEstimated or actual date or date-time the condition began, in the opinion of the clinician.Period
ConditiononsetRangeEstimated or actual date or date-time the condition began, in the opinion of the clinician.Range
ConditiononsetStringEstimated or actual date or date-time the condition began, in the opinion of the clinician.notDefined
Condition_onsetStringExtensions for onsetStringElement
ConditionabatementDateTimeThe date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.notDefined
Condition_abatementDateTimeExtensions for abatementDateTimeElement
ConditionabatementAgeThe date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.Age
ConditionabatementPeriodThe date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.Period
ConditionabatementRangeThe date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.Range
ConditionabatementStringThe date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.notDefined
Condition_abatementStringExtensions for abatementStringElement
ConditionrecordedDateThe recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.dateTime
Condition_recordedDateExtensions for recordedDateElement
ConditionrecorderIndividual who recorded the record and takes responsibility for its content.Reference
ConditionasserterIndividual or device that is making the condition statement.Reference
ConditionstageClinical stage or grade of a condition. May include formal severity assessments.Condition_Stage
ConditionevidenceSupporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.Condition_Evidence
ConditionnoteAdditional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.Annotation
ConditionDefinitionresourceTypeThis is a ConditionDefinition resourceConditionDefinition
ConditionDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ConditionDefinitionmetaThe metadata about the resource. 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
ConditionDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
ConditionDefinition_implicitRulesExtensions for implicitRulesElement
ConditionDefinitionlanguageThe base language in which the resource is written.code
ConditionDefinition_languageExtensions for languageElement
ConditionDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ConditionDefinitioncontainedThese 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
ConditionDefinitionextensionMay be 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
ConditionDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ConditionDefinitionurlAn absolute URI that is used to identify this condition definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this condition definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the condition definition is stored on different servers.uri
ConditionDefinition_urlExtensions for urlElement
ConditionDefinitionidentifierA formal identifier that is used to identify this condition definition when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
ConditionDefinitionversionThe identifier that is used to identify this version of the condition definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the condition definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.string
ConditionDefinition_versionExtensions for versionElement
ConditionDefinitionnameA natural language name identifying the condition definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.string
ConditionDefinition_nameExtensions for nameElement
ConditionDefinitiontitleA short, descriptive, user-friendly title for the condition definition.string
ConditionDefinition_titleExtensions for titleElement
ConditionDefinitionstatusThe status of this condition definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
ConditionDefinition_statusExtensions for statusElement
ConditionDefinitionexperimentalA Boolean value to indicate that this condition definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.boolean
ConditionDefinition_experimentalExtensions for experimentalElement
ConditionDefinitiondateThe date (and optionally time) when the condition 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 condition definition changes.dateTime
ConditionDefinition_dateExtensions for dateElement
ConditionDefinitionpublisherThe name of the organization or individual that published the condition definition.string
ConditionDefinition_publisherExtensions for publisherElement
ConditionDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ConditionDefinitiondescriptionA free text natural language description of the condition definition from a consumer's perspective.markdown
ConditionDefinition_descriptionExtensions for descriptionElement
ConditionDefinitionuseContextThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate condition definition instances.UsageContext
ConditionDefinitionjurisdictionA legal or geographic region in which the condition definition is intended to be used.CodeableConcept
ConditionDefinitionpurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
ConditionDefinition_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
ConditionDefinitionapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
ConditionDefinition_approvalDateExtensions for approvalDateElement
ConditionDefinitionlastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
ConditionDefinition_lastReviewDateExtensions for lastReviewDateElement
ConditionDefinitioneffectivePeriodThe period during which the {{title}} content was or is planned to be in active use.Period
ConditionDefinitionsubtitleAn explanatory or alternate title for the event definition giving additional information about its content.string
ConditionDefinition_subtitleExtensions for subtitleElement
ConditionDefinitioncodeIdentification of the condition, problem or diagnosis.CodeableConcept
ConditionDefinitionseverityA subjective assessment of the severity of the condition as evaluated by the clinician.CodeableConcept
ConditionDefinitionbodySiteThe anatomical location where this condition manifests itself.CodeableConcept
ConditionDefinitionstageClinical stage or grade of a condition. May include formal severity assessments.CodeableConcept
ConditionDefinitionhasSeverityWhether Severity is appropriate to collect for this condition.boolean
ConditionDefinition_hasSeverityExtensions for hasSeverityElement
ConditionDefinitionhasBodySiteWhether bodySite is appropriate to collect for this condition.boolean
ConditionDefinition_hasBodySiteExtensions for hasBodySiteElement
ConditionDefinitionhasStageWhether stage is appropriate to collect for this condition.boolean
ConditionDefinition_hasStageExtensions for hasStageElement
ConditionDefinitiondefinitionFormal definitions of the condition. These may be references to ontologies, published clinical protocols or research papers.uri
ConditionDefinition_definitionExtensions for definitionElement
ConditionDefinitionobservationObservations particularly relevant to this condition.ConditionDefinition_Observation
ConditionDefinitionmedicationMedications particularly relevant for this condition.ConditionDefinition_Medication
ConditionDefinitionpreconditionAn observation that suggests that this condition applies.ConditionDefinition_Precondition
ConditionDefinitionteamAppropriate team for this condition.Reference
ConditionDefinitionquestionnaireQuestionnaire for this condition.ConditionDefinition_Questionnaire
ConditionDefinitionplanPlan that is appropriate.ConditionDefinition_Plan
ConditionDefinition_MedicationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConditionDefinition_MedicationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ConditionDefinition_MedicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ConditionDefinition_MedicationcategoryCategory that is relevant.CodeableConcept
ConditionDefinition_MedicationcodeCode for relevant Medication.CodeableConcept
ConditionDefinition_ObservationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConditionDefinition_ObservationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ConditionDefinition_ObservationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ConditionDefinition_ObservationcategoryCategory that is relevant.CodeableConcept
ConditionDefinition_ObservationcodeCode for relevant Observation.CodeableConcept
ConditionDefinition_PlanidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConditionDefinition_PlanextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ConditionDefinition_PlanmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ConditionDefinition_PlanroleUse for the plan.CodeableConcept
ConditionDefinition_PlanreferenceThe actual plan.Reference
ConditionDefinition_PreconditionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConditionDefinition_PreconditionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ConditionDefinition_PreconditionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ConditionDefinition_PreconditiontypeKind of pre-condition.enum values:
sensitive
specific
ConditionDefinition_Precondition_typeExtensions for typeElement
ConditionDefinition_PreconditioncodeCode for relevant Observation.CodeableConcept
ConditionDefinition_PreconditionvalueCodeableConceptValue of Observation.CodeableConcept
ConditionDefinition_PreconditionvalueQuantityValue of Observation.Quantity
ConditionDefinition_QuestionnaireidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ConditionDefinition_QuestionnaireextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ConditionDefinition_QuestionnairemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ConditionDefinition_QuestionnairepurposeUse of the questionnaire.enum values:
preadmit
diff-diagnosis
outcome
ConditionDefinition_Questionnaire_purposeExtensions for purposeElement
ConditionDefinition_QuestionnairereferenceSpecific Questionnaire.Reference
Condition_EvidenceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Condition_EvidenceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EvidencemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EvidencecodeA manifestation or symptom that led to the recording of this condition.CodeableConcept
Condition_EvidencedetailLinks to other relevant information, including pathology reports.Reference
Condition_StageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Condition_StageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StagesummaryA simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.CodeableConcept
Condition_StageassessmentReference to a formal record of the evidence on which the staging assessment is based.Reference
Condition_StagetypeThe kind of staging, such as pathological or clinical staging.CodeableConcept
resourceTypeThis is a Consent resourceConsent
idThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
metaThe metadata about the resource. 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
implicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
_implicitRulesExtensions for implicitRulesElement
languageThe base language in which the resource is written.code
_languageExtensions for languageElement
textA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
containedThese 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
extensionMay be 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
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
identifierUnique identifier for this copy of the Consent Statement.Identifier
statusIndicates the current state of this Consent resource.enum values:
draft
active
inactive
entered-in-error
unknown
_statusExtensions for statusElement
scopeA selector of the type of consent being presented: Privacy, Treatment, or Research. This list is now extensible.CodeableConcept
categoryA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.CodeableConcept
subjectThe patient/healthcare practitioner to whom this consent applies.Reference
dateTimeDate and time the consent instance was agreed to.dateTime
_dateTimeExtensions for dateTimeElement
performerEither 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
organizationThe organization that manages the consent, and the framework within which it is executed.Reference
sourceAttachmentThe source on which this consent statement is based. The source might be a scanned original paper form.Attachment
sourceReferenceA 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
policyThe 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
policyRuleA reference to the specific base computable regulation or policy.CodeableConcept
verificationWhether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.Consent_Verification
provisionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.Consent_Provision
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
roleHow the individual is involved in the resources content that is described in the exception.CodeableConcept
referenceThe 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
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
meaningHow the resource reference is interpreted when testing consent restrictions.enum values:
instance
related
dependents
authoredby
_meaningExtensions for meaningElement
referenceA reference to a specific resource that defines which resources are covered by this consent.Reference
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
authorityEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.uri
_authorityExtensions for authorityElement
uriThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.uri
_uriExtensions for uriElement
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
typeAction 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
_typeExtensions for typeElement
periodThe timeframe in this rule is valid.Period
actorWho 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
actionActions controlled by this Rule.CodeableConcept
securityLabelA security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.Coding
purposeThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.Coding
classThe 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
codeIf this code is found in an instance, then the rule applies.CodeableConcept
dataPeriodClinical or Operational Relevant period of time that bounds the data controlled by this rule.Period
dataThe resources controlled by this rule if specific resources are referenced.Consent_Data
provisionRules which provide exceptions to the base rule or subrules.Consent_Provision
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
verifiedHas the instruction been verified.boolean
_verifiedExtensions for verifiedElement
verificationTypeExtensible list of verification type starting with verification and re-validation.CodeableConcept
verifiedByThe person who conducted the verification/validation of the Grantee decision.Reference
verifiedWithWho verified the instruction (Patient, Relative or other Authorized Person).Reference
verificationDateDate(s) verification was collected.dateTime
_verificationDateExtensions for verificationDateElement
ContactDetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ContactDetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ContactDetailnameThe name of an individual to contact.string
ContactDetail_nameExtensions for nameElement
ContactDetailtelecomThe contact details for the individual (if a name was provided) or the organization.ContactPoint
ContactPointidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ContactPointextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ContactPointsystemTelecommunications 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_systemExtensions for systemElement
ContactPointvalueThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).string
ContactPoint_valueExtensions for valueElement
ContactPointuseIdentifies the purpose for the contact point.enum values:
home
work
temp
old
mobile
ContactPoint_useExtensions for useElement
ContactPointrankSpecifies 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_rankExtensions for rankElement
ContactPointperiodTime period when the contact point was/is in use.Period
ContractresourceTypeThis is a Contract resourceContract
ContractidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ContractmetaThe metadata about the resource. 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
ContractimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ContractlanguageThe base language in which the resource is written.code
Contract_languageExtensions for languageElement
ContracttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ContractcontainedThese 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
ContractextensionMay be 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
ContractmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ContractidentifierUnique identifier for this Contract or a derivative that references a Source Contract.Identifier
ContracturlCanonical identifier for this contract, represented as a URI (globally unique).uri
Contract_urlExtensions for urlElement
ContractversionAn edition identifier used for business purposes to label business significant variants.string
Contract_versionExtensions for versionElement
ContractstatusThe status of the resource instance.code
Contract_statusExtensions for statusElement
ContractlegalStateLegal 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
ContractinstantiatesCanonicalThe URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.Reference
ContractinstantiatesUriThe URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.uri
Contract_instantiatesUriExtensions for instantiatesUriElement
ContractcontentDerivativeThe minimal content derived from the basal information source at a specific stage in its lifecycle.CodeableConcept
ContractissuedWhen this Contract was issued.dateTime
Contract_issuedExtensions for issuedElement
ContractappliesRelevant time or time-period when this Contract is applicable.Period
ContractexpirationTypeEvent resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.CodeableConcept
ContractsubjectThe target entity impacted by or of interest to parties to the agreement.Reference
ContractauthorityA 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
ContractdomainRecognized 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
ContractsiteSites in which the contract is complied with, exercised, or in force.Reference
ContractnameA 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_nameExtensions for nameElement
ContracttitleA 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_titleExtensions for titleElement
ContractsubtitleAn 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_subtitleExtensions for subtitleElement
ContractaliasAlternative 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_aliasExtensions for aliasElement
ContractauthorThe individual or organization that authored the Contract definition, derivative, or instance in any legal state.Reference
ContractscopeA selector of legal concerns for this Contract definition, derivative, or instance in any legal state.CodeableConcept
ContracttopicCodeableConceptNarrows the range of legal concerns to focus on the achievement of specific contractual objectives.CodeableConcept
ContracttopicReferenceNarrows the range of legal concerns to focus on the achievement of specific contractual objectives.Reference
ContracttypeA 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
ContractsubTypeSub-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
ContractcontentDefinitionPrecusory 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
ContracttermOne or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.Contract_Term
ContractsupportingInfoInformation that may be needed by/relevant to the performer in their execution of this term action.Reference
ContractrelevantHistoryLinks 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
ContractsignerParties 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
ContractfriendlyThe "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
legalList of Legal expressions or representations of this Contract.Contract_Legal
ContractruleList of Computable Policy Rule Language Representations of this Contract.Contract_Rule
ContractlegallyBindingAttachmentLegally 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
ContractlegallyBindingReferenceLegally 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_ActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_ActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ActiondoNotPerformTrue if the term prohibits the action.boolean
Contract_Action_doNotPerformExtensions for doNotPerformElement
Contract_ActiontypeActivity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.CodeableConcept
Contract_ActionsubjectEntity of the action.Contract_Subject
Contract_ActionintentReason or purpose for the action stipulated by this Contract Provision.CodeableConcept
Contract_ActionlinkIdId [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.string
Contract_Action_linkIdExtensions for linkIdElement
Contract_ActionstatusCurrent state of the term action.CodeableConcept
Contract_ActioncontextEncounter or Episode with primary association to specified term activity.Reference
Contract_ActioncontextLinkIdId [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.string
Contract_Action_contextLinkIdExtensions for contextLinkIdElement
Contract_ActionoccurrenceDateTimeWhen action happens.notDefined
Contract_Action_occurrenceDateTimeExtensions for occurrenceDateTimeElement
Contract_ActionoccurrencePeriodWhen action happens.Period
Contract_ActionoccurrenceTimingWhen action happens.Timing
Contract_ActionrequesterWho or what initiated the action and has responsibility for its activation.Reference
Contract_ActionrequesterLinkIdId [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.string
Contract_Action_requesterLinkIdExtensions for requesterLinkIdElement
Contract_ActionperformerTypeThe type of individual that is desired or required to perform or not perform the action.CodeableConcept
Contract_ActionperformerRoleThe type of role or competency of an individual desired or required to perform or not perform the action.CodeableConcept
Contract_ActionperformerIndicates who or what is being asked to perform (or not perform) the ction.Reference
Contract_ActionperformerLinkIdId [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_performerLinkIdExtensions for performerLinkIdElement
Contract_ActionreasonRationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. Either a coded concept, or another resource whose existence justifies permitting or not permitting this action.CodeableReference
Contract_ActionreasonLinkIdId [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_reasonLinkIdExtensions for reasonLinkIdElement
Contract_ActionnoteComments made about the term action made by the requester, performer, subject or other participants.Annotation
Contract_ActionsecurityLabelNumberSecurity labels that protects the action.unsignedInt
Contract_Action_securityLabelNumberExtensions for securityLabelNumberElement
Contract_AnsweridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_AnswerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AnswermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AnswervalueBooleanResponse 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_valueBooleanExtensions for valueBooleanElement
Contract_AnswervalueDecimalResponse 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_valueDecimalExtensions for valueDecimalElement
Contract_AnswervalueIntegerResponse 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_valueIntegerExtensions for valueIntegerElement
Contract_AnswervalueDateResponse 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_valueDateExtensions for valueDateElement
Contract_AnswervalueDateTimeResponse 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_valueDateTimeExtensions for valueDateTimeElement
Contract_AnswervalueTimeResponse 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_valueTimeExtensions for valueTimeElement
Contract_AnswervalueStringResponse 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_valueStringExtensions for valueStringElement
Contract_AnswervalueUriResponse 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_valueUriExtensions for valueUriElement
Contract_AnswervalueAttachmentResponse 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_AnswervalueCodingResponse 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_AnswervalueQuantityResponse 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_AnswervalueReferenceResponse 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_AssetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_AssetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AssetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AssetscopeDifferentiates the kind of the asset .CodeableConcept
Contract_AssettypeTarget entity type about which the term may be concerned.CodeableConcept
Contract_AssettypeReferenceAssociated entities.Reference
Contract_AssetsubtypeMay be a subtype or part of an offered asset.CodeableConcept
Contract_AssetrelationshipSpecifies 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_AssetcontextCircumstance of the asset.Contract_Context
Contract_AssetconditionDescription of the quality and completeness of the asset that imay be a factor in its valuation.string
Contract_Asset_conditionExtensions for conditionElement
Contract_AssetperiodTypeType of Asset availability for use or ownership.CodeableConcept
Contract_AssetperiodAsset relevant contractual time period.Period
Contract_AssetusePeriodTime period of asset use.Period
Contract_AssettextClause 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_textExtensions for textElement
Contract_AssetlinkIdId [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.string
Contract_Asset_linkIdExtensions for linkIdElement
Contract_AssetanswerResponse to assets.Contract_Answer
Contract_AssetsecurityLabelNumberSecurity labels that protects the asset.unsignedInt
Contract_Asset_securityLabelNumberExtensions for securityLabelNumberElement
Contract_AssetvaluedItemContract Valued Item List.Contract_ValuedItem
Contract_ContentDefinitionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_ContentDefinitionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContentDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContentDefinitiontypePrecusory 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_ContentDefinitionsubTypeDetailed Precusory content type.CodeableConcept
Contract_ContentDefinitionpublisherThe individual or organization that published the Contract precursor content.Reference
Contract_ContentDefinitionpublicationDateThe 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_publicationDateExtensions for publicationDateElement
Contract_ContentDefinitionpublicationStatusamended | appended | cancelled | disputed | entered-in-error | executable +.code
Contract_ContentDefinition_publicationStatusExtensions for publicationStatusElement
copyrightA copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.markdown
_copyrightExtensions for copyrightElement
Contract_ContextidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_ContextextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContextmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContextreferenceAsset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.Reference
Contract_ContextcodeCoded representation of the context generally or of the Referenced entity, such as the asset holder type or location.CodeableConcept
Contract_ContexttextContext description.string
Contract_Context_textExtensions for textElement
Contract_FriendlyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_FriendlyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FriendlymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FriendlycontentAttachmentHuman readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.Attachment
Contract_FriendlycontentReferenceHuman readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.Reference
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
contentAttachmentContract legal text in human renderable form.Attachment
contentReferenceContract legal text in human renderable form.Reference
Contract_OfferidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_OfferextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OffermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OfferidentifierUnique identifier for this particular Contract Provision.Identifier
Contract_OfferpartyOffer Recipient.Contract_Party
Contract_OffertopicThe 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_OffertypeType of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.CodeableConcept
Contract_OfferdecisionType of choice made by accepting party with respect to an offer made by an offeror/ grantee.CodeableConcept
Contract_OfferdecisionModeHow the decision about a Contract was conveyed.CodeableConcept
Contract_OfferanswerResponse to offer text.Contract_Answer
Contract_OffertextHuman readable form of this Contract Offer.string
Contract_Offer_textExtensions for textElement
Contract_OfferlinkIdThe id of the clause or question text of the offer in the referenced questionnaire/response.string
Contract_Offer_linkIdExtensions for linkIdElement
Contract_OffersecurityLabelNumberSecurity labels that protects the offer.unsignedInt
Contract_Offer_securityLabelNumberExtensions for securityLabelNumberElement
Contract_PartyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_PartyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PartymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PartyreferenceParticipant in the offer.Reference
Contract_PartyroleHow the party participates in the offer.CodeableConcept
Contract_RuleidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_RuleextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RulemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RulecontentAttachmentComputable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).Attachment
Contract_RulecontentReferenceComputable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).Reference
Contract_SecurityLabelidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_SecurityLabelextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SecurityLabelmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SecurityLabelnumberNumber used to link this term or term element to the applicable Security Label.unsignedInt
Contract_SecurityLabel_numberExtensions for numberElement
Contract_SecurityLabelclassificationSecurity label privacy tag that species the level of confidentiality protection required for this term and/or term elements.Coding
Contract_SecurityLabelcategorySecurity label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.Coding
Contract_SecurityLabelcontrolSecurity label privacy tag that species the manner in which term and/or term elements are to be protected.Coding
Contract_SigneridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_SignerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SignermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SignertypeRole of this Contract signer, e.g. notary, grantee.Coding
Contract_SignerpartyParty which is a signator to this Contract.Reference
Contract_SignersignatureLegally binding Contract DSIG signature contents in Base64.Signature
Contract_SubjectidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_SubjectextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubjectmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubjectreferenceThe entity the action is performed or not performed on or for.Reference
Contract_SubjectroleRole type of agent assigned roles in this Contract.CodeableConcept
Contract_TermidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_TermextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TermmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TermidentifierUnique identifier for this particular Contract Provision.Identifier
Contract_TermissuedWhen this Contract Provision was issued.dateTime
Contract_Term_issuedExtensions for issuedElement
Contract_TermappliesRelevant time or time-period when this Contract Provision is applicable.Period
Contract_TermtopicCodeableConceptThe entity that the term applies to.CodeableConcept
Contract_TermtopicReferenceThe entity that the term applies to.Reference
Contract_TermtypeA 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_TermsubTypeA specialized legal clause or condition based on overarching contract type.CodeableConcept
Contract_TermtextStatement of a provision in a policy or a contract.string
Contract_Term_textExtensions for textElement
Contract_TermsecurityLabelSecurity labels that protect the handling of information about the term and its elements, which may be specifically identified..Contract_SecurityLabel
Contract_TermofferThe matter of concern in the context of this provision of the agrement.Contract_Offer
Contract_TermassetContract Term Asset List.Contract_Asset
Contract_TermactionAn 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_TermgroupNested group of Contract Provisions.Contract_Term
Contract_ValuedItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Contract_ValuedItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ValuedItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ValuedItementityCodeableConceptSpecific type of Contract Valued Item that may be priced.CodeableConcept
Contract_ValuedItementityReferenceSpecific type of Contract Valued Item that may be priced.Reference
Contract_ValuedItemidentifierIdentifies a Contract Valued Item instance.Identifier
Contract_ValuedItemeffectiveTimeIndicates the time during which this Contract ValuedItem information is effective.dateTime
Contract_ValuedItem_effectiveTimeExtensions for effectiveTimeElement
Contract_ValuedItemquantitySpecifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.Quantity
Contract_ValuedItemunitPriceA Contract Valued Item unit valuation measure.Money
Contract_ValuedItemfactorA 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_factorExtensions for factorElement
Contract_ValuedItempointsAn 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_pointsExtensions for pointsElement
Contract_ValuedItemnetExpresses 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_ValuedItempaymentTerms of valuation.string
Contract_ValuedItem_paymentExtensions for paymentElement
Contract_ValuedItempaymentDateWhen payment is due.dateTime
Contract_ValuedItem_paymentDateExtensions for paymentDateElement
Contract_ValuedItemresponsibleWho will make payment.Reference
Contract_ValuedItemrecipientWho will receive payment.Reference
Contract_ValuedItemlinkIdId of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.string
Contract_ValuedItem_linkIdExtensions for linkIdElement
Contract_ValuedItemsecurityLabelNumberA set of security labels that define which terms are controlled by this condition.unsignedInt
Contract_ValuedItem_securityLabelNumberExtensions for securityLabelNumberElement
ContributoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ContributorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ContributortypeThe type of contributor.enum values:
author
editor
reviewer
endorser
Contributor_typeExtensions for typeElement
ContributornameThe name of the individual or organization responsible for the contribution.string
Contributor_nameExtensions for nameElement
ContributorcontactContact details to assist a user in finding and communicating with the contributor.ContactDetail
CountidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CountextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
CountvalueThe value of the measured amount. The value includes an implicit precision in the presentation of the value.decimal
Count_valueExtensions for valueElement
CountcomparatorHow 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_comparatorExtensions for comparatorElement
CountunitA human-readable form of the unit.string
Count_unitExtensions for unitElement
CountsystemThe identification of the system that provides the coded form of the unit.uri
Count_systemExtensions for systemElement
CountcodeA computer processable form of the unit in some unit representation system.code
Count_codeExtensions for codeElement
CoverageresourceTypeThis is a Coverage resourceCoverage
CoverageidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CoveragemetaThe metadata about the resource. 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
CoverageimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CoveragelanguageThe base language in which the resource is written.code
Coverage_languageExtensions for languageElement
CoveragetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CoveragecontainedThese 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
CoverageextensionMay be 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
CoveragemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CoverageidentifierA unique identifier assigned to this coverage.Identifier
CoveragestatusThe status of the resource instance.code
Coverage_statusExtensions for statusElement
CoveragetypeThe type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.CodeableConcept
CoveragepolicyHolderThe party who 'owns' the insurance policy.Reference
CoveragesubscriberThe 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
CoveragesubscriberIdThe insurer assigned ID for the Subscriber.Identifier
CoveragebeneficiaryThe party who benefits from the insurance coverage; the patient when products and/or services are provided.Reference
CoveragedependentA designator for a dependent under the coverage.string
Coverage_dependentExtensions for dependentElement
CoveragerelationshipThe relationship of beneficiary (patient) to the subscriber.CodeableConcept
CoverageperiodTime 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
CoveragepayorThe program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.Reference
CoverageclassA suite of underwriter specific classifiers.Coverage_Class
CoverageorderThe 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_orderExtensions for orderElement
CoveragenetworkThe 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_networkExtensions for networkElement
CoveragecostToBeneficiaryA 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
CoveragesubrogationWhen 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.boolean
Coverage_subrogationExtensions for subrogationElement
CoveragecontractThe policy(s) which constitute this insurance coverage.Reference
CoverageEligibilityRequestresourceTypeThis is a CoverageEligibilityRequest resourceCoverageEligibilityRequest
CoverageEligibilityRequestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CoverageEligibilityRequestmetaThe metadata about the resource. 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
CoverageEligibilityRequestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CoverageEligibilityRequestlanguageThe base language in which the resource is written.code
CoverageEligibilityRequest_languageExtensions for languageElement
CoverageEligibilityRequesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CoverageEligibilityRequestcontainedThese 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
CoverageEligibilityRequestextensionMay be 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
CoverageEligibilityRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CoverageEligibilityRequestidentifierA unique identifier assigned to this coverage eligiblity request.Identifier
CoverageEligibilityRequeststatusThe status of the resource instance.code
CoverageEligibilityRequest_statusExtensions for statusElement
CoverageEligibilityRequestpriorityWhen the requestor expects the processor to complete processing.CodeableConcept
CoverageEligibilityRequestpurposeCode 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_purposeExtensions for purposeElement
CoverageEligibilityRequestpatientThe party who is the beneficiary of the supplied coverage and for whom eligibility is sought.Reference
CoverageEligibilityRequestservicedDateThe date or dates when the enclosed suite of services were performed or completed.notDefined
CoverageEligibilityRequest_servicedDateExtensions for servicedDateElement
CoverageEligibilityRequestservicedPeriodThe date or dates when the enclosed suite of services were performed or completed.Period
CoverageEligibilityRequestcreatedThe date when this resource was created.dateTime
CoverageEligibilityRequest_createdExtensions for createdElement
CoverageEligibilityRequestentererPerson who created the request.Reference
CoverageEligibilityRequestproviderThe provider which is responsible for the request.Reference
CoverageEligibilityRequestinsurerThe Insurer who issued the coverage in question and is the recipient of the request.Reference
CoverageEligibilityRequestfacilityFacility where the services are intended to be provided.Reference
CoverageEligibilityRequestsupportingInfoAdditional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.CoverageEligibilityRequest_SupportingInfo
CoverageEligibilityRequestinsuranceFinancial instruments for reimbursement for the health care products and services.CoverageEligibilityRequest_Insurance
CoverageEligibilityRequestitemService 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_DiagnosisidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityRequest_DiagnosisextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DiagnosismodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DiagnosisdiagnosisCodeableConceptThe nature of illness or problem in a coded form or as a reference to an external defined Condition.CodeableConcept
CoverageEligibilityRequest_DiagnosisdiagnosisReferenceThe nature of illness or problem in a coded form or as a reference to an external defined Condition.Reference
CoverageEligibilityRequest_InsuranceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityRequest_InsuranceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InsurancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InsurancefocalA flag to indicate that this Coverage is to be used for evaluation of this request when set to true.boolean
CoverageEligibilityRequest_Insurance_focalExtensions for focalElement
CoverageEligibilityRequest_InsurancecoverageReference 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_InsurancebusinessArrangementA business agreement number established between the provider and the insurer for special business processing purposes.string
CoverageEligibilityRequest_Insurance_businessArrangementExtensions for businessArrangementElement
CoverageEligibilityRequest_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityRequest_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemsupportingInfoSequenceExceptions, special conditions and supporting information applicable for this service or product line.positiveInt
CoverageEligibilityRequest_Item_supportingInfoSequenceExtensions for supportingInfoSequenceElement
CoverageEligibilityRequest_ItemcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
CoverageEligibilityRequest_ItemproductOrServiceThis contains the product, service, drug or other billing code for the item.CodeableConcept
CoverageEligibilityRequest_ItemmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
CoverageEligibilityRequest_ItemproviderThe practitioner who is responsible for the product or service to be rendered to the patient.Reference
CoverageEligibilityRequest_ItemquantityThe number of repetitions of a service or product.Quantity
CoverageEligibilityRequest_ItemunitPriceThe amount charged to the patient by the provider for a single unit.Money
CoverageEligibilityRequest_ItemfacilityFacility where the services will be provided.Reference
CoverageEligibilityRequest_ItemdiagnosisPatient diagnosis for which care is sought.CoverageEligibilityRequest_Diagnosis
CoverageEligibilityRequest_ItemdetailThe plan/proposal/order describing the proposed service in detail.Reference
CoverageEligibilityRequest_SupportingInfoidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityRequest_SupportingInfoextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SupportingInfomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SupportingInfosequenceA number to uniquely identify supporting information entries.positiveInt
CoverageEligibilityRequest_SupportingInfo_sequenceExtensions for sequenceElement
CoverageEligibilityRequest_SupportingInfoinformationAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Reference
CoverageEligibilityRequest_SupportingInfoappliesToAllThe supporting materials are applicable for all detail items, product/servce categories and specific billing codes.boolean
CoverageEligibilityRequest_SupportingInfo_appliesToAllExtensions for appliesToAllElement
CoverageEligibilityResponseresourceTypeThis is a CoverageEligibilityResponse resourceCoverageEligibilityResponse
CoverageEligibilityResponseidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
CoverageEligibilityResponsemetaThe metadata about the resource. 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
CoverageEligibilityResponseimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
CoverageEligibilityResponselanguageThe base language in which the resource is written.code
CoverageEligibilityResponse_languageExtensions for languageElement
CoverageEligibilityResponsetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
CoverageEligibilityResponsecontainedThese 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
CoverageEligibilityResponseextensionMay be 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
CoverageEligibilityResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
CoverageEligibilityResponseidentifierA unique identifier assigned to this coverage eligiblity request.Identifier
CoverageEligibilityResponsestatusThe status of the resource instance.code
CoverageEligibilityResponse_statusExtensions for statusElement
CoverageEligibilityResponsepurposeCode 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_purposeExtensions for purposeElement
CoverageEligibilityResponsepatientThe party who is the beneficiary of the supplied coverage and for whom eligibility is sought.Reference
CoverageEligibilityResponseservicedDateThe date or dates when the enclosed suite of services were performed or completed.notDefined
CoverageEligibilityResponse_servicedDateExtensions for servicedDateElement
CoverageEligibilityResponseservicedPeriodThe date or dates when the enclosed suite of services were performed or completed.Period
CoverageEligibilityResponsecreatedThe date this resource was created.dateTime
CoverageEligibilityResponse_createdExtensions for createdElement
CoverageEligibilityResponserequestorThe provider which is responsible for the request.Reference
CoverageEligibilityResponserequestReference to the original request resource.Reference
CoverageEligibilityResponseoutcomeThe outcome of the request processing.enum values:
queued
complete
error
partial
CoverageEligibilityResponse_outcomeExtensions for outcomeElement
CoverageEligibilityResponsedispositionA human readable description of the status of the adjudication.string
CoverageEligibilityResponse_dispositionExtensions for dispositionElement
CoverageEligibilityResponseinsurerThe Insurer who issued the coverage in question and is the author of the response.Reference
CoverageEligibilityResponseinsuranceFinancial instruments for reimbursement for the health care products and services.CoverageEligibilityResponse_Insurance
CoverageEligibilityResponsepreAuthRefA reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.string
CoverageEligibilityResponse_preAuthRefExtensions for preAuthRefElement
CoverageEligibilityResponseformA code for the form to be used for printing the content.CodeableConcept
CoverageEligibilityResponseerrorErrors encountered during the processing of the request.CoverageEligibilityResponse_Error
CoverageEligibilityResponse_BenefitidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityResponse_BenefitextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_BenefitmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_BenefittypeClassification of benefit being provided.CodeableConcept
CoverageEligibilityResponse_BenefitallowedUnsignedIntThe quantity of the benefit which is permitted under the coverage.notDefined
CoverageEligibilityResponse_Benefit_allowedUnsignedIntExtensions for allowedUnsignedIntElement
CoverageEligibilityResponse_BenefitallowedStringThe quantity of the benefit which is permitted under the coverage.notDefined
CoverageEligibilityResponse_Benefit_allowedStringExtensions for allowedStringElement
CoverageEligibilityResponse_BenefitallowedMoneyThe quantity of the benefit which is permitted under the coverage.Money
CoverageEligibilityResponse_BenefitusedUnsignedIntThe quantity of the benefit which have been consumed to date.notDefined
CoverageEligibilityResponse_Benefit_usedUnsignedIntExtensions for usedUnsignedIntElement
CoverageEligibilityResponse_BenefitusedStringThe quantity of the benefit which have been consumed to date.notDefined
CoverageEligibilityResponse_Benefit_usedStringExtensions for usedStringElement
CoverageEligibilityResponse_BenefitusedMoneyThe quantity of the benefit which have been consumed to date.Money
CoverageEligibilityResponse_ErroridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityResponse_ErrorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ErrormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ErrorcodeAn error code,from a specified code system, which details why the eligibility check could not be performed.CodeableConcept
CoverageEligibilityResponse_InsuranceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityResponse_InsuranceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InsurancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InsurancecoverageReference 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_InsuranceinforceFlag 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_inforceExtensions for inforceElement
CoverageEligibilityResponse_InsurancebenefitPeriodThe term of the benefits documented in this response.Period
CoverageEligibilityResponse_InsuranceitemBenefits and optionally current balances, and authorization details by category or service.CoverageEligibilityResponse_Item
CoverageEligibilityResponse_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
CoverageEligibilityResponse_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
CoverageEligibilityResponse_ItemproductOrServiceThis contains the product, service, drug or other billing code for the item.CodeableConcept
CoverageEligibilityResponse_ItemmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
CoverageEligibilityResponse_ItemproviderThe practitioner who is eligible for the provision of the product or service.Reference
CoverageEligibilityResponse_ItemexcludedTrue 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_excludedExtensions for excludedElement
CoverageEligibilityResponse_ItemnameA short name or tag for the benefit.string
CoverageEligibilityResponse_Item_nameExtensions for nameElement
CoverageEligibilityResponse_ItemdescriptionA richer description of the benefit or services covered.string
CoverageEligibilityResponse_Item_descriptionExtensions for descriptionElement
CoverageEligibilityResponse_ItemnetworkIs a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.CodeableConcept
CoverageEligibilityResponse_ItemunitIndicates if the benefits apply to an individual or to the family.CodeableConcept
CoverageEligibilityResponse_ItemtermThe term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.CodeableConcept
CoverageEligibilityResponse_ItembenefitBenefits used to date.CoverageEligibilityResponse_Benefit
CoverageEligibilityResponse_ItemauthorizationRequiredA boolean flag indicating whether a preauthorization is required prior to actual service delivery.boolean
CoverageEligibilityResponse_Item_authorizationRequiredExtensions for authorizationRequiredElement
CoverageEligibilityResponse_ItemauthorizationSupportingCodes or comments regarding information or actions associated with the preauthorization.CodeableConcept
CoverageEligibilityResponse_ItemauthorizationUrlA web location for obtaining requirements or descriptive information regarding the preauthorization.uri
CoverageEligibilityResponse_Item_authorizationUrlExtensions for authorizationUrlElement
Coverage_ClassidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Coverage_ClassextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ClassmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ClasstypeThe 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_ClassvalueThe alphanumeric string value associated with the insurer issued label.string
Coverage_Class_valueExtensions for valueElement
Coverage_ClassnameA short description for the class.string
Coverage_Class_nameExtensions for nameElement
Coverage_CostToBeneficiaryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Coverage_CostToBeneficiaryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CostToBeneficiarymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CostToBeneficiarytypeThe category of patient centric costs associated with treatment.CodeableConcept
Coverage_CostToBeneficiaryvalueQuantityThe amount due from the patient for the cost category.Quantity
Coverage_CostToBeneficiaryvalueMoneyThe amount due from the patient for the cost category.Money
Coverage_CostToBeneficiaryexceptionA suite of codes indicating exceptions or reductions to patient costs and their effective periods.Coverage_Exception
Coverage_ExceptionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Coverage_ExceptionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ExceptionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ExceptiontypeThe code for the specific exception.CodeableConcept
Coverage_ExceptionperiodThe timeframe during when the exception is in force.Period
DataRequirementidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DataRequirementextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
DataRequirementtypeThe 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_typeExtensions for typeElement
DataRequirementprofileThe profile of the required data, specified as the uri of the profile definition.canonical
DataRequirementsubjectCodeableConceptThe intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.CodeableConcept
DataRequirementsubjectReferenceThe intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.Reference
DataRequirementmustSupportIndicates 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_mustSupportExtensions for mustSupportElement
DataRequirementcodeFilterCode 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
DataRequirementdateFilterDate 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
DataRequirementlimitSpecifies a maximum number of results that are required (uses the _count search parameter).positiveInt
DataRequirement_limitExtensions for limitElement
DataRequirementsortSpecifies the order of the results to be returned.DataRequirement_Sort
DataRequirement_CodeFilteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DataRequirement_CodeFilterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CodeFiltermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CodeFilterpathThe 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_pathExtensions for pathElement
DataRequirement_CodeFiltersearchParamA 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_searchParamExtensions for searchParamElement
DataRequirement_CodeFiltervalueSetThe 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_CodeFiltercodeThe 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_DateFilteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DataRequirement_DateFilterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DateFiltermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DateFilterpathThe 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_pathExtensions for pathElement
DataRequirement_DateFiltersearchParamA 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_searchParamExtensions for searchParamElement
DataRequirement_DateFiltervalueDateTimeThe 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_valueDateTimeExtensions for valueDateTimeElement
DataRequirement_DateFiltervaluePeriodThe 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_DateFiltervalueDurationThe 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_SortidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DataRequirement_SortextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SortmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SortpathThe 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_pathExtensions for pathElement
DataRequirement_SortdirectionThe direction of the sort, ascending or descending.enum values:
ascending
descending
DataRequirement_Sort_directionExtensions for directionElement
DataTypeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DataTypeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
DetectedIssueresourceTypeThis is a DetectedIssue resourceDetectedIssue
DetectedIssueidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DetectedIssuemetaThe metadata about the resource. 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
DetectedIssueimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DetectedIssuelanguageThe base language in which the resource is written.code
DetectedIssue_languageExtensions for languageElement
DetectedIssuetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DetectedIssuecontainedThese 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
DetectedIssueextensionMay be 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
DetectedIssuemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DetectedIssueidentifierBusiness identifier associated with the detected issue record.Identifier
DetectedIssuestatusIndicates the status of the detected issue.code
DetectedIssue_statusExtensions for statusElement
DetectedIssuecodeIdentifies the general type of issue identified.CodeableConcept
DetectedIssueseverityIndicates the degree of importance associated with the identified issue based on the potential impact on the patient.enum values:
high
moderate
low
DetectedIssue_severityExtensions for severityElement
DetectedIssuepatientIndicates the patient whose record the detected issue is associated with.Reference
DetectedIssueidentifiedDateTimeThe date or period when the detected issue was initially identified.notDefined
DetectedIssue_identifiedDateTimeExtensions for identifiedDateTimeElement
DetectedIssueidentifiedPeriodThe date or period when the detected issue was initially identified.Period
DetectedIssueauthorIndividual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.Reference
DetectedIssueimplicatedIndicates the resource representing the current activity or proposed activity that is potentially problematic.Reference
DetectedIssueevidenceSupporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.DetectedIssue_Evidence
DetectedIssuedetailA textual explanation of the detected issue.string
DetectedIssue_detailExtensions for detailElement
DetectedIssuereferenceThe literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.uri
DetectedIssue_referenceExtensions for referenceElement
DetectedIssuemitigationIndicates 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_EvidenceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DetectedIssue_EvidenceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EvidencemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EvidencecodeA manifestation that led to the recording of this detected issue.CodeableConcept
DetectedIssue_EvidencedetailLinks to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.Reference
DetectedIssue_MitigationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DetectedIssue_MitigationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MitigationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MitigationactionDescribes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.CodeableConcept
DetectedIssue_MitigationdateIndicates when the mitigating action was documented.dateTime
DetectedIssue_Mitigation_dateExtensions for dateElement
DetectedIssue_MitigationauthorIdentifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.Reference
DeviceresourceTypeThis is a Device resourceDevice
DeviceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DevicemetaThe metadata about the resource. 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
DeviceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DevicelanguageThe base language in which the resource is written.code
Device_languageExtensions for languageElement
DevicetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DevicecontainedThese 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
DeviceextensionMay be 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
DevicemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DeviceidentifierUnique instance identifiers assigned to a device by manufacturers other organizations or owners.Identifier
DevicedisplayNameThe name used to display by default when the device is referenced. Based on intent of use by the resource creator, this may reflect one of the names in Device.deviceName, or may be another simple name.string
Device_displayNameExtensions for displayNameElement
DevicedefinitionThe reference to the definition for the device.Reference
DeviceudiCarrierUnique 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
DevicestatusStatus of the Device availability.enum values:
active
inactive
entered-in-error
unknown
Device_statusExtensions for statusElement
DevicestatusReasonReason for the dtatus of the Device availability.CodeableConcept
DevicedistinctIdentifierThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.string
Device_distinctIdentifierExtensions for distinctIdentifierElement
DevicemanufacturerA name of the manufacturer or entity legally responsible for the device.string
Device_manufacturerExtensions for manufacturerElement
DevicemanufactureDateThe date and time when the device was manufactured.dateTime
Device_manufactureDateExtensions for manufactureDateElement
DeviceexpirationDateThe date and time beyond which this device is no longer valid or should not be used (if applicable).dateTime
Device_expirationDateExtensions for expirationDateElement
DevicelotNumberLot number assigned by the manufacturer.string
Device_lotNumberExtensions for lotNumberElement
DeviceserialNumberThe serial number assigned by the organization when the device was manufactured.string
Device_serialNumberExtensions for serialNumberElement
DevicedeviceNameThis 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
DevicemodelNumberThe manufacturer's model number for the device.string
Device_modelNumberExtensions for modelNumberElement
DevicepartNumberThe part number or catalog number of the device.string
Device_partNumberExtensions for partNumberElement
DevicetypeThe kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.CodeableConcept
DevicespecializationThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.Device_Specialization
DeviceversionThe actual design of the device or software version running on the device.Device_Version
DevicepropertyThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.Device_Property
DevicepatientPatient information, if the device is affixed to, or associated to a patient for their specific use, irrespective of the procedure, use, observation, or other activity that the device is involved in.Reference
DeviceoperationalStatusThe status of the device itself - whether it is switched on, or activated, etc.Device_OperationalStatus
DeviceassociationStatusThe state of the usage or application of the device - whether the device is implanted, or explanted, or attached to the patient.Device_AssociationStatus
DeviceownerAn organization that is responsible for the provision and ongoing maintenance of the device.Reference
DevicecontactContact details for an organization or a particular human that is responsible for the device.ContactPoint
DevicelocationThe place where the device can be found.Reference
DeviceurlA network address on which the device may be contacted directly.uri
Device_urlExtensions for urlElement
DevicenoteDescriptive information, usage information or implantation information that is not captured in an existing element.Annotation
DevicesafetyProvides additional safety characteristics about a medical device. For example devices containing latex.CodeableConcept
DeviceparentThe device that this device is attached to or is part of.Reference
DeviceDefinitionresourceTypeThis is a DeviceDefinition resourceDeviceDefinition
DeviceDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DeviceDefinitionmetaThe metadata about the resource. 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
DeviceDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DeviceDefinitionlanguageThe base language in which the resource is written.code
DeviceDefinition_languageExtensions for languageElement
DeviceDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DeviceDefinitioncontainedThese 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
DeviceDefinitionextensionMay be 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
DeviceDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DeviceDefinitionidentifierUnique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.Identifier
DeviceDefinitionudiDeviceIdentifierUnique 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
DeviceDefinitionmanufacturerStringA name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.notDefined
DeviceDefinition_manufacturerStringExtensions for manufacturerStringElement
DeviceDefinitionmanufacturerReferenceA name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.Reference
DeviceDefinitiondeviceNameThe name or names of the device as given by the manufacturer.DeviceDefinition_DeviceName
DeviceDefinitionmodelNumberThe model number for the device for example as defined by the manufacturer or labeler, or other agency.string
DeviceDefinition_modelNumberExtensions for modelNumberElement
DeviceDefinitiontypeWhat kind of device or device system this is.CodeableConcept
DeviceDefinitionspecializationThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.DeviceDefinition_Specialization
DeviceDefinitionversionThe available versions of the device, e.g., software versions.string
DeviceDefinition_versionExtensions for versionElement
DeviceDefinitionsafetySafety characteristics of the device.CodeableConcept
DeviceDefinitionshelfLifeStorageShelf Life and storage information.ProductShelfLife
DeviceDefinitionphysicalCharacteristicsPhysical characteristics to define or specify the product - for example dimensions, color etc. These can be defined by the manufacturer or labeler, or can be used to specify characteristics when ordering.ProdCharacteristic
DeviceDefinitionlanguageCodeLanguage code for the human-readable text strings produced by the device (all supported).CodeableConcept
DeviceDefinitioncapabilityAdditional capabilities that the device is defined or required to have e.g. "water resistant", "long life".DeviceDefinition_Capability
DeviceDefinitionpropertyThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.DeviceDefinition_Property
DeviceDefinitionownerAn organization that is responsible for the provision and ongoing maintenance of the device.Reference
DeviceDefinitioncontactContact details for an organization or a particular human that is responsible for the device.ContactPoint
DeviceDefinitiononlineInformationAccess to on-line information about the device.uri
DeviceDefinition_onlineInformationExtensions for onlineInformationElement
DeviceDefinitionnoteDescriptive information, usage information or implantation information that is not captured in an existing element.Annotation
DeviceDefinitionquantityThe 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
DeviceDefinitionparentDeviceThe parent device it can be part of.Reference
DeviceDefinitionmaterialA substance used to create the material(s) of which the device is made.DeviceDefinition_Material
DeviceDefinition_CapabilityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceDefinition_CapabilityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CapabilitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CapabilitytypeThe type of capability - whether it is a physical attribute, a customization needed. For exampl e "water ingress protection".CodeableConcept
DeviceDefinition_CapabilitydescriptionThe actual capability of the device e.g. IP67.CodeableConcept
DeviceDefinition_DeviceNameidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceDefinition_DeviceNameextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DeviceNamemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DeviceNamenameA human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.string
DeviceDefinition_DeviceName_nameExtensions for nameElement
DeviceDefinition_DeviceNametypeThe 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_typeExtensions for typeElement
DeviceDefinition_MaterialidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceDefinition_MaterialextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MaterialmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MaterialsubstanceA substance that the device contains, may contain, or is made of - for example latex - to be used to determine patient compatibility. This is not intended to represent the composition of the device, only the clinically relevant materials.CodeableConcept
DeviceDefinition_MaterialalternateIndicates an alternative material of the device.boolean
DeviceDefinition_Material_alternateExtensions for alternateElement
DeviceDefinition_MaterialallergenicIndicatorWhether the substance is a known or suspected allergen.boolean
DeviceDefinition_Material_allergenicIndicatorExtensions for allergenicIndicatorElement
DeviceDefinition_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceDefinition_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PropertytypeCode that specifies the property DeviceDefinitionPropetyCode (Extensible).CodeableConcept
DeviceDefinition_PropertyvalueQuantityProperty value as a quantity.Quantity
DeviceDefinition_PropertyvalueCodeProperty value as a code, e.g., NTP4 (synced to NTP).CodeableConcept
DeviceDefinition_SpecializationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceDefinition_SpecializationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SpecializationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SpecializationsystemTypeThe standard that is used to operate and communicate.string
DeviceDefinition_Specialization_systemTypeExtensions for systemTypeElement
DeviceDefinition_SpecializationversionThe version of the standard that is used to operate and communicate.string
DeviceDefinition_Specialization_versionExtensions for versionElement
DeviceDefinition_UdiDeviceIdentifieridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceDefinition_UdiDeviceIdentifierextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_UdiDeviceIdentifiermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_UdiDeviceIdentifierdeviceIdentifierThe 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_deviceIdentifierExtensions for deviceIdentifierElement
DeviceDefinition_UdiDeviceIdentifierissuerThe organization that assigns the identifier algorithm.uri
DeviceDefinition_UdiDeviceIdentifier_issuerExtensions for issuerElement
DeviceDefinition_UdiDeviceIdentifierjurisdictionThe jurisdiction to which the deviceIdentifier applies.uri
DeviceDefinition_UdiDeviceIdentifier_jurisdictionExtensions for jurisdictionElement
DeviceMetricresourceTypeThis is a DeviceMetric resourceDeviceMetric
DeviceMetricidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DeviceMetricmetaThe metadata about the resource. 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
DeviceMetricimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DeviceMetriclanguageThe base language in which the resource is written.code
DeviceMetric_languageExtensions for languageElement
DeviceMetrictextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DeviceMetriccontainedThese 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
DeviceMetricextensionMay be 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
DeviceMetricmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DeviceMetricidentifierUnique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.Identifier
DeviceMetrictypeDescribes the type of the metric. For example: Heart Rate, PEEP Setting, etc.CodeableConcept
DeviceMetricunitDescribes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.CodeableConcept
DeviceMetricsourceDescribes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.Reference
DeviceMetricparentDescribes 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
DeviceMetricoperationalStatusIndicates current operational state of the device. For example: On, Off, Standby, etc.enum values:
on
off
standby
entered-in-error
DeviceMetric_operationalStatusExtensions for operationalStatusElement
DeviceMetriccolorDescribes 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_colorExtensions for colorElement
DeviceMetriccategoryIndicates 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_categoryExtensions for categoryElement
DeviceMetricmeasurementPeriodDescribes 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
DeviceMetriccalibrationDescribes the calibrations that have been performed or that are required to be performed.DeviceMetric_Calibration
DeviceMetric_CalibrationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceMetric_CalibrationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CalibrationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CalibrationtypeDescribes the type of the calibration method.enum values:
unspecified
offset
gain
two-point
DeviceMetric_Calibration_typeExtensions for typeElement
DeviceMetric_CalibrationstateDescribes the state of the calibration.enum values:
not-calibrated
calibration-required
calibrated
unspecified
DeviceMetric_Calibration_stateExtensions for stateElement
DeviceMetric_CalibrationtimeDescribes the time last calibration has been performed.instant
DeviceMetric_Calibration_timeExtensions for timeElement
DeviceRequestresourceTypeThis is a DeviceRequest resourceDeviceRequest
DeviceRequestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DeviceRequestmetaThe metadata about the resource. 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
DeviceRequestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DeviceRequestlanguageThe base language in which the resource is written.code
DeviceRequest_languageExtensions for languageElement
DeviceRequesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DeviceRequestcontainedThese 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
DeviceRequestextensionMay be 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
DeviceRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DeviceRequestidentifierIdentifiers assigned to this order by the orderer or by the receiver.Identifier
DeviceRequestinstantiatesCanonicalThe 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
DeviceRequestinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
DeviceRequestbasedOnPlan/proposal/order fulfilled by this request.Reference
DeviceRequestpriorRequestThe request takes the place of the referenced completed or terminated request(s).Reference
DeviceRequestgroupIdentifierComposite request this is part of.Identifier
DeviceRequeststatusThe status of the request.code
DeviceRequest_statusExtensions for statusElement
DeviceRequestintentWhether the request is a proposal, plan, an original order or a reflex order.code
DeviceRequest_intentExtensions for intentElement
DeviceRequestpriorityIndicates how quickly the {{title}} should be addressed with respect to other requests.code
DeviceRequest_priorityExtensions for priorityElement
DeviceRequestcodeThe details of the device to be used.CodeableReference
DeviceRequestparameterSpecific parameters for the ordered item. For example, the prism value for lenses.DeviceRequest_Parameter
DeviceRequestsubjectThe patient who will use the device.Reference
DeviceRequestencounterAn encounter that provides additional context in which this request is made.Reference
DeviceRequestoccurrenceDateTimeThe 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_occurrenceDateTimeExtensions for occurrenceDateTimeElement
DeviceRequestoccurrencePeriodThe 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
DeviceRequestoccurrenceTimingThe 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
DeviceRequestauthoredOnWhen the request transitioned to being actionable.dateTime
DeviceRequest_authoredOnExtensions for authoredOnElement
DeviceRequestrequesterThe individual who initiated the request and has responsibility for its activation.Reference
DeviceRequestperformerTypeDesired type of performer for doing the diagnostic testing.CodeableConcept
DeviceRequestperformerThe desired performer for doing the diagnostic testing.Reference
DeviceRequestreasonReason or justification for the use of this device.CodeableReference
DeviceRequestinsuranceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.Reference
DeviceRequestsupportingInfoAdditional 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
DeviceRequestnoteDetails 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
DeviceRequestrelevantHistoryKey events in the history of the request.Reference
DeviceRequest_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DeviceRequest_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParametercodeA code or string that identifies the device detail being asserted.CodeableConcept
DeviceRequest_ParametervalueCodeableConceptThe value of the device detail.CodeableConcept
DeviceRequest_ParametervalueQuantityThe value of the device detail.Quantity
DeviceRequest_ParametervalueRangeThe value of the device detail.Range
DeviceRequest_ParametervalueBooleanThe value of the device detail.notDefined
DeviceRequest_Parameter_valueBooleanExtensions for valueBooleanElement
DeviceUseStatementresourceTypeThis is a DeviceUseStatement resourceDeviceUseStatement
DeviceUseStatementidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DeviceUseStatementmetaThe metadata about the resource. 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
DeviceUseStatementimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DeviceUseStatementlanguageThe base language in which the resource is written.code
DeviceUseStatement_languageExtensions for languageElement
DeviceUseStatementtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DeviceUseStatementcontainedThese 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
DeviceUseStatementextensionMay be 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
DeviceUseStatementmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DeviceUseStatementidentifierAn external identifier for this statement such as an IRI.Identifier
DeviceUseStatementbasedOnA plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.Reference
DeviceUseStatementstatusA 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_statusExtensions for statusElement
DeviceUseStatementcategoryThis attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).CodeableConcept
DeviceUseStatementsubjectThe patient who used the device.Reference
DeviceUseStatementderivedFromAllows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.Reference
DeviceUseStatementcontextThe encounter or episode of care that establishes the context for this device use statement.Reference
DeviceUseStatementtimingTimingHow often the device was used.Timing
DeviceUseStatementtimingPeriodHow often the device was used.Period
DeviceUseStatementtimingDateTimeHow often the device was used.notDefined
DeviceUseStatement_timingDateTimeExtensions for timingDateTimeElement
DeviceUseStatementdateAssertedThe time at which the statement was recorded by informationSource.dateTime
DeviceUseStatement_dateAssertedExtensions for dateAssertedElement
DeviceUseStatementusageStatusThe status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement.CodeableConcept
DeviceUseStatementusageReasonThe reason for asserting the usage status - for example forgot, lost, stolen, broken.CodeableConcept
DeviceUseStatementinformationSourceWho reported the device was being used by the patient.Reference
DeviceUseStatementdeviceCode or Reference to device used.CodeableReference
DeviceUseStatementreasonReason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUseStatement.CodeableReference
DeviceUseStatementbodySiteIndicates the anotomic location on the subject's body where the device was used ( i.e. the target).CodeableReference
DeviceUseStatementnoteDetails 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_AssociationStatusidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Device_AssociationStatusextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AssociationStatusmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AssociationStatusvalueimplanted|explanted|attached.CodeableConcept
Device_AssociationStatusreasonThe reasons given for the current association status - i.e. why is the device explanted, or attached to the patient, etc.CodeableConcept
Device_DeviceNameidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Device_DeviceNameextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DeviceNamemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DeviceNamenameThe name that identifies the device.string
Device_DeviceName_nameExtensions for nameElement
Device_DeviceNametypeThe type of deviceName. Note that ManufactureDeviceName means that the name is the name as given by the manufacturer, not the name of the manufacturer. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.enum values:
udi-label-name
user-friendly-name
patient-reported-name
manufacturer-name
model-name
other
Device_DeviceName_typeExtensions for typeElement
Device_OperationalStatusidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Device_OperationalStatusextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OperationalStatusmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OperationalStatusvalueon |off | standby.CodeableConcept
Device_OperationalStatusreasonThe reasons given for the current operational status - i.e. why is the device switched on etc.CodeableConcept
Device_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Device_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PropertytypeCode that specifies the property being represented. No codes are specified but the MDC codes are an example: https://build.fhir.org/mdc.html.CodeableConcept
Device_PropertyvalueQuantityProperty value as a quantity.Quantity
Device_PropertyvalueCodeProperty value as a code, e.g., NTP4 (synced to NTP).CodeableConcept
Device_SpecializationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Device_SpecializationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SpecializationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SpecializationsystemTypeThe standard that is used to operate and communicate.CodeableConcept
Device_SpecializationversionThe version of the standard that is used to operate and communicate.string
Device_Specialization_versionExtensions for versionElement
Device_UdiCarrieridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Device_UdiCarrierextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_UdiCarriermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_UdiCarrierdeviceIdentifierThe 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_deviceIdentifierExtensions for deviceIdentifierElement
Device_UdiCarrierissuerOrganization 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_issuerExtensions for issuerElement
Device_UdiCarrierjurisdictionThe 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_jurisdictionExtensions for jurisdictionElement
Device_UdiCarriercarrierAIDCThe 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_carrierAIDCExtensions for carrierAIDCElement
Device_UdiCarriercarrierHRFThe 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_carrierHRFExtensions for carrierHRFElement
Device_UdiCarrierentryTypeA coded entry to indicate how the data was entered.enum values:
barcode
rfid
manual
card
self-reported
electronic-transmission
unknown
Device_UdiCarrier_entryTypeExtensions for entryTypeElement
Device_VersionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Device_VersionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_VersionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_VersiontypeThe type of the device version, e.g. manufacturer, approved, internal.CodeableConcept
Device_VersioncomponentThe hardware or software module of the device to which the version applies.Identifier
Device_VersionvalueThe version text.string
Device_Version_valueExtensions for valueElement
DiagnosticReportresourceTypeThis is a DiagnosticReport resourceDiagnosticReport
DiagnosticReportidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DiagnosticReportmetaThe metadata about the resource. 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
DiagnosticReportimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DiagnosticReportlanguageThe base language in which the resource is written.code
DiagnosticReport_languageExtensions for languageElement
DiagnosticReporttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DiagnosticReportcontainedThese 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
DiagnosticReportextensionMay be 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
DiagnosticReportmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DiagnosticReportidentifierIdentifiers assigned to this report by the performer or other systems.Identifier
DiagnosticReportbasedOnDetails concerning a service requested.Reference
DiagnosticReportstatusThe status of the diagnostic report.enum values:
registered
partial
preliminary
final
amended
corrected
appended
cancelled
entered-in-error
unknown
DiagnosticReport_statusExtensions for statusElement
DiagnosticReportcategoryA 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
DiagnosticReportcodeA code or name that describes this diagnostic report.CodeableConcept
DiagnosticReportsubjectThe 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
DiagnosticReportencounterThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.Reference
DiagnosticReporteffectiveDateTimeThe 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_effectiveDateTimeExtensions for effectiveDateTimeElement
DiagnosticReporteffectivePeriodThe 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
DiagnosticReportissuedThe date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.instant
DiagnosticReport_issuedExtensions for issuedElement
DiagnosticReportperformerThe diagnostic service that is responsible for issuing the report.Reference
DiagnosticReportresultsInterpreterThe practitioner or organization that is responsible for the report's conclusions and interpretations.Reference
DiagnosticReportspecimenDetails about the specimens on which this diagnostic report is based.Reference
DiagnosticReportresult[Observations](observation.html) that are part of this diagnostic report.Reference
DiagnosticReportimagingStudyOne 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
DiagnosticReportmediaA 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
DiagnosticReportconclusionConcise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.string
DiagnosticReport_conclusionExtensions for conclusionElement
DiagnosticReportconclusionCodeOne or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.CodeableConcept
DiagnosticReportpresentedFormRich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.Attachment
DiagnosticReport_MediaidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DiagnosticReport_MediaextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MediamodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MediacommentA 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_commentExtensions for commentElement
linkReference to the image source.Reference
DistanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DistanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
DistancevalueThe value of the measured amount. The value includes an implicit precision in the presentation of the value.decimal
Distance_valueExtensions for valueElement
DistancecomparatorHow 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_comparatorExtensions for comparatorElement
DistanceunitA human-readable form of the unit.string
Distance_unitExtensions for unitElement
DistancesystemThe identification of the system that provides the coded form of the unit.uri
Distance_systemExtensions for systemElement
DistancecodeA computer processable form of the unit in some unit representation system.code
Distance_codeExtensions for codeElement
DocumentManifestresourceTypeThis is a DocumentManifest resourceDocumentManifest
DocumentManifestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DocumentManifestmetaThe metadata about the resource. 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
DocumentManifestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DocumentManifestlanguageThe base language in which the resource is written.code
DocumentManifest_languageExtensions for languageElement
DocumentManifesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DocumentManifestcontainedThese 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
DocumentManifestextensionMay be 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
DocumentManifestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DocumentManifestmasterIdentifierA single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.Identifier
DocumentManifestidentifierOther identifiers associated with the document manifest, including version independent identifiers.Identifier
DocumentManifeststatusThe status of this document manifest.enum values:
current
superseded
entered-in-error
DocumentManifest_statusExtensions for statusElement
DocumentManifesttypeThe code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.CodeableConcept
DocumentManifestsubjectWho 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
DocumentManifestcreatedWhen 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_createdExtensions for createdElement
DocumentManifestauthorIdentifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.Reference
DocumentManifestrecipientA patient, practitioner, or organization for which this set of documents is intended.Reference
DocumentManifestsourceIdentifies the source system, application, or software that produced the document manifest.uri
DocumentManifest_sourceExtensions for sourceElement
DocumentManifestdescriptionHuman-readable description of the source document. This is sometimes known as the "title".string
DocumentManifest_descriptionExtensions for descriptionElement
DocumentManifestcontentThe list of Resources that consist of the parts of this manifest.Reference
relatedRelated identifiers or resources associated with the DocumentManifest.DocumentManifest_Related
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
identifierRelated identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.Identifier
refRelated Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.Reference
DocumentReferenceresourceTypeThis is a DocumentReference resourceDocumentReference
DocumentReferenceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
DocumentReferencemetaThe metadata about the resource. 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
DocumentReferenceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
DocumentReferencelanguageThe base language in which the resource is written.code
DocumentReference_languageExtensions for languageElement
DocumentReferencetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
DocumentReferencecontainedThese 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
DocumentReferenceextensionMay be 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
DocumentReferencemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
DocumentReferencemasterIdentifierDocument 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
DocumentReferenceidentifierOther identifiers associated with the document, including version independent identifiers.Identifier
DocumentReferencestatusThe status of this document reference.enum values:
current
superseded
entered-in-error
DocumentReference_statusExtensions for statusElement
DocumentReferencedocStatusThe status of the underlying document.code
DocumentReference_docStatusExtensions for docStatusElement
DocumentReferencetypeSpecifies 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
DocumentReferencecategoryA 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
DocumentReferencesubjectWho 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
DocumentReferencedateWhen the document reference was created.instant
DocumentReference_dateExtensions for dateElement
DocumentReferenceauthorIdentifies who is responsible for adding the information to the document.Reference
DocumentReferenceauthenticatorWhich person or organization authenticates that this document is valid.Reference
DocumentReferencecustodianIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document.Reference
DocumentReferencerelatesToRelationships that this document has with other document references that already exist.DocumentReference_RelatesTo
DocumentReferencedescriptionHuman-readable description of the source document.string
DocumentReference_descriptionExtensions for descriptionElement
DocumentReferencesecurityLabelA 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
DocumentReferencecontentThe document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.DocumentReference_Content
DocumentReferencecontextThe clinical context in which the document was prepared.DocumentReference_Context
DocumentReference_ContentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DocumentReference_ContentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContentattachmentThe document or URL of the document along with critical metadata to prove content has integrity.Attachment
DocumentReference_ContentformatAn identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.Coding
DocumentReference_ContextidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DocumentReference_ContextextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContextmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContextencounterDescribes the clinical encounter or type of care that the document content is associated with.Reference
DocumentReference_ContexteventThis 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_ContextperiodThe time period over which the service that is described by the document was provided.Period
DocumentReference_ContextfacilityTypeThe kind of facility where the patient was seen.CodeableConcept
DocumentReference_ContextpracticeSettingThis property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.CodeableConcept
DocumentReference_ContextsourcePatientInfoThe Patient Information as known when the document was published. May be a reference to a version specific, or contained.Reference
relatedRelated identifiers or resources associated with the DocumentReference.Reference
DocumentReference_ContextbasedOnA procedure that is fulfilled in whole or in part by the creation of this media.Reference
DocumentReference_RelatesToidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DocumentReference_RelatesToextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RelatesTomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RelatesTocodeThe type of relationship that this document has with anther document.enum values:
replaces
transforms
signs
appends
DocumentReference_RelatesTo_codeExtensions for codeElement
DocumentReference_RelatesTotargetThe target document of this relationship.Reference
DosageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DosageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
DosagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
DosagesequenceIndicates the order in which the dosage instructions should be applied or interpreted.integer
Dosage_sequenceExtensions for sequenceElement
DosagetextFree text dosage instructions e.g. SIG.string
Dosage_textExtensions for textElement
DosageadditionalInstructionSupplemental 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
DosagepatientInstructionInstructions in terms that are understood by the patient or consumer.string
Dosage_patientInstructionExtensions for patientInstructionElement
DosagetimingWhen medication should be administered.Timing
DosageasNeededBooleanIndicates 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_asNeededBooleanExtensions for asNeededBooleanElement
DosageasNeededCodeableConceptIndicates 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
DosagesiteBody site to administer to.CodeableConcept
DosagerouteHow drug should enter body.CodeableConcept
DosagemethodTechnique for administering medication.CodeableConcept
DosagedoseAndRateThe amount of medication administered.Dosage_DoseAndRate
DosagemaxDosePerPeriodUpper limit on medication per unit of time.Ratio
DosagemaxDosePerAdministrationUpper limit on medication per administration.Quantity
DosagemaxDosePerLifetimeUpper limit on medication per lifetime of the patient.Quantity
Dosage_DoseAndRateidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Dosage_DoseAndRateextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DoseAndRatemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DoseAndRatetypeThe kind of dose or rate specified, for example, ordered or calculated.CodeableConcept
Dosage_DoseAndRatedoseRangeAmount of medication per dose.Range
Dosage_DoseAndRatedoseQuantityAmount of medication per dose.Quantity
Dosage_DoseAndRaterateRatioAmount of medication per unit of time.Ratio
Dosage_DoseAndRaterateRangeAmount of medication per unit of time.Range
Dosage_DoseAndRaterateQuantityAmount of medication per unit of time.Quantity
DurationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
DurationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
DurationvalueThe value of the measured amount. The value includes an implicit precision in the presentation of the value.decimal
Duration_valueExtensions for valueElement
DurationcomparatorHow 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_comparatorExtensions for comparatorElement
DurationunitA human-readable form of the unit.string
Duration_unitExtensions for unitElement
DurationsystemThe identification of the system that provides the coded form of the unit.uri
Duration_systemExtensions for systemElement
DurationcodeA computer processable form of the unit in some unit representation system.code
Duration_codeExtensions for codeElement
ElementidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ElementDefinitionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinitionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ElementDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ElementDefinitionpathThe 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_pathExtensions for pathElement
ElementDefinitionrepresentationCodes 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_representationExtensions for representationElement
ElementDefinitionsliceNameThe 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_sliceNameExtensions for sliceNameElement
ElementDefinitionsliceIsConstrainingIf 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_sliceIsConstrainingExtensions for sliceIsConstrainingElement
ElementDefinitionlabelA 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_labelExtensions for labelElement
ElementDefinitioncodeA code that has the same meaning as the element in a particular terminology.Coding
ElementDefinitionslicingIndicates 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
ElementDefinitionshortA concise description of what this element means (e.g. for use in autogenerated summaries).string
ElementDefinition_shortExtensions for shortElement
ElementDefinitiondefinitionProvides 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_definitionExtensions for definitionElement
ElementDefinitioncommentExplanatory 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_commentExtensions for commentElement
ElementDefinitionrequirementsThis 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_requirementsExtensions for requirementsElement
ElementDefinitionaliasIdentifies additional names by which this element might also be known.string
ElementDefinition_aliasExtensions for aliasElement
ElementDefinitionminThe minimum number of times this element SHALL appear in the instance.unsignedInt
ElementDefinition_minExtensions for minElement
ElementDefinitionmaxThe maximum number of times this element is permitted to appear in the instance.string
ElementDefinition_maxExtensions for maxElement
ElementDefinitionbaseInformation 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
ElementDefinitioncontentReferenceIdentifies 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_contentReferenceExtensions for contentReferenceElement
ElementDefinitiontypeThe data type or resource that the value of this element is permitted to be.ElementDefinition_Type
ElementDefinitiondefaultValueBase64BinaryThe 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_defaultValueBase64BinaryExtensions for defaultValueBase64BinaryElement
ElementDefinitiondefaultValueBooleanThe 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_defaultValueBooleanExtensions for defaultValueBooleanElement
ElementDefinitiondefaultValueCanonicalThe 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_defaultValueCanonicalExtensions for defaultValueCanonicalElement
ElementDefinitiondefaultValueCodeThe 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_defaultValueCodeExtensions for defaultValueCodeElement
ElementDefinitiondefaultValueDateThe 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_defaultValueDateExtensions for defaultValueDateElement
ElementDefinitiondefaultValueDateTimeThe 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_defaultValueDateTimeExtensions for defaultValueDateTimeElement
ElementDefinitiondefaultValueDecimalThe 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_defaultValueDecimalExtensions for defaultValueDecimalElement
ElementDefinitiondefaultValueIdThe 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_defaultValueIdExtensions for defaultValueIdElement
ElementDefinitiondefaultValueInstantThe 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_defaultValueInstantExtensions for defaultValueInstantElement
ElementDefinitiondefaultValueIntegerThe 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_defaultValueIntegerExtensions for defaultValueIntegerElement
ElementDefinitiondefaultValueInteger64The 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_defaultValueInteger64Extensions for defaultValueInteger64Element
ElementDefinitiondefaultValueMarkdownThe 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_defaultValueMarkdownExtensions for defaultValueMarkdownElement
ElementDefinitiondefaultValueOidThe 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_defaultValueOidExtensions for defaultValueOidElement
ElementDefinitiondefaultValuePositiveIntThe 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_defaultValuePositiveIntExtensions for defaultValuePositiveIntElement
ElementDefinitiondefaultValueStringThe 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_defaultValueStringExtensions for defaultValueStringElement
ElementDefinitiondefaultValueTimeThe 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_defaultValueTimeExtensions for defaultValueTimeElement
ElementDefinitiondefaultValueUnsignedIntThe 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_defaultValueUnsignedIntExtensions for defaultValueUnsignedIntElement
ElementDefinitiondefaultValueUriThe 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_defaultValueUriExtensions for defaultValueUriElement
ElementDefinitiondefaultValueUrlThe 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_defaultValueUrlExtensions for defaultValueUrlElement
ElementDefinitiondefaultValueUuidThe 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_defaultValueUuidExtensions for defaultValueUuidElement
ElementDefinitiondefaultValueAddressThe 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
ElementDefinitiondefaultValueAgeThe 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
ElementDefinitiondefaultValueAnnotationThe 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
ElementDefinitiondefaultValueAttachmentThe 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
ElementDefinitiondefaultValueCodeableConceptThe 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
ElementDefinitiondefaultValueCodingThe 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
ElementDefinitiondefaultValueContactPointThe 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
ElementDefinitiondefaultValueCountThe 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
ElementDefinitiondefaultValueDistanceThe 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
ElementDefinitiondefaultValueDurationThe 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
ElementDefinitiondefaultValueHumanNameThe 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
ElementDefinitiondefaultValueIdentifierThe 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
ElementDefinitiondefaultValueMoneyThe 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
ElementDefinitiondefaultValuePeriodThe 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
ElementDefinitiondefaultValueQuantityThe 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
ElementDefinitiondefaultValueRangeThe 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
ElementDefinitiondefaultValueRatioThe 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
ElementDefinitiondefaultValueReferenceThe 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
ElementDefinitiondefaultValueSampledDataThe 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
ElementDefinitiondefaultValueSignatureThe 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
ElementDefinitiondefaultValueTimingThe 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
ElementDefinitiondefaultValueContactDetailThe 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
ElementDefinitiondefaultValueContributorThe 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
ElementDefinitiondefaultValueDataRequirementThe 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
ElementDefinitiondefaultValueExpressionThe 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
ElementDefinitiondefaultValueParameterDefinitionThe 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
ElementDefinitiondefaultValueRelatedArtifactThe 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
ElementDefinitiondefaultValueTriggerDefinitionThe 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
ElementDefinitiondefaultValueUsageContextThe 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
ElementDefinitiondefaultValueDosageThe 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
ElementDefinitiondefaultValueMetaThe value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').Meta
ElementDefinitionmeaningWhenMissingThe 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_meaningWhenMissingExtensions for meaningWhenMissingElement
ElementDefinitionorderMeaningIf 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_orderMeaningExtensions for orderMeaningElement
ElementDefinitionfixedBase64BinarySpecifies 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_fixedBase64BinaryExtensions for fixedBase64BinaryElement
ElementDefinitionfixedBooleanSpecifies 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_fixedBooleanExtensions for fixedBooleanElement
ElementDefinitionfixedCanonicalSpecifies 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_fixedCanonicalExtensions for fixedCanonicalElement
ElementDefinitionfixedCodeSpecifies 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_fixedCodeExtensions for fixedCodeElement
ElementDefinitionfixedDateSpecifies 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_fixedDateExtensions for fixedDateElement
ElementDefinitionfixedDateTimeSpecifies 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_fixedDateTimeExtensions for fixedDateTimeElement
ElementDefinitionfixedDecimalSpecifies 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_fixedDecimalExtensions for fixedDecimalElement
ElementDefinitionfixedIdSpecifies 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_fixedIdExtensions for fixedIdElement
ElementDefinitionfixedInstantSpecifies 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_fixedInstantExtensions for fixedInstantElement
ElementDefinitionfixedIntegerSpecifies 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_fixedIntegerExtensions for fixedIntegerElement
ElementDefinitionfixedInteger64Specifies 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_fixedInteger64Extensions for fixedInteger64Element
ElementDefinitionfixedMarkdownSpecifies 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_fixedMarkdownExtensions for fixedMarkdownElement
ElementDefinitionfixedOidSpecifies 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_fixedOidExtensions for fixedOidElement
ElementDefinitionfixedPositiveIntSpecifies 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_fixedPositiveIntExtensions for fixedPositiveIntElement
ElementDefinitionfixedStringSpecifies 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_fixedStringExtensions for fixedStringElement
ElementDefinitionfixedTimeSpecifies 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_fixedTimeExtensions for fixedTimeElement
ElementDefinitionfixedUnsignedIntSpecifies 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_fixedUnsignedIntExtensions for fixedUnsignedIntElement
ElementDefinitionfixedUriSpecifies 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_fixedUriExtensions for fixedUriElement
ElementDefinitionfixedUrlSpecifies 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_fixedUrlExtensions for fixedUrlElement
ElementDefinitionfixedUuidSpecifies 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_fixedUuidExtensions for fixedUuidElement
ElementDefinitionfixedAddressSpecifies 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
ElementDefinitionfixedAgeSpecifies 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
ElementDefinitionfixedAnnotationSpecifies 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
ElementDefinitionfixedAttachmentSpecifies 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
ElementDefinitionfixedCodeableConceptSpecifies 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
ElementDefinitionfixedCodingSpecifies 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
ElementDefinitionfixedContactPointSpecifies 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
ElementDefinitionfixedCountSpecifies 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
ElementDefinitionfixedDistanceSpecifies 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
ElementDefinitionfixedDurationSpecifies 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
ElementDefinitionfixedHumanNameSpecifies 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
ElementDefinitionfixedIdentifierSpecifies 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
ElementDefinitionfixedMoneySpecifies 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
ElementDefinitionfixedPeriodSpecifies 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
ElementDefinitionfixedQuantitySpecifies 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
ElementDefinitionfixedRangeSpecifies 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
ElementDefinitionfixedRatioSpecifies 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
ElementDefinitionfixedReferenceSpecifies 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
ElementDefinitionfixedSampledDataSpecifies 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
ElementDefinitionfixedSignatureSpecifies 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
ElementDefinitionfixedTimingSpecifies 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
ElementDefinitionfixedContactDetailSpecifies 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
ElementDefinitionfixedContributorSpecifies 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
ElementDefinitionfixedDataRequirementSpecifies 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
ElementDefinitionfixedExpressionSpecifies 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
ElementDefinitionfixedParameterDefinitionSpecifies 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
ElementDefinitionfixedRelatedArtifactSpecifies 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
ElementDefinitionfixedTriggerDefinitionSpecifies 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
ElementDefinitionfixedUsageContextSpecifies 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
ElementDefinitionfixedDosageSpecifies 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
ElementDefinitionfixedMetaSpecifies 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.Meta
ElementDefinitionpatternBase64BinarySpecifies 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_patternBase64BinaryExtensions for patternBase64BinaryElement
ElementDefinitionpatternBooleanSpecifies 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_patternBooleanExtensions for patternBooleanElement
ElementDefinitionpatternCanonicalSpecifies 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_patternCanonicalExtensions for patternCanonicalElement
ElementDefinitionpatternCodeSpecifies 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_patternCodeExtensions for patternCodeElement
ElementDefinitionpatternDateSpecifies 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_patternDateExtensions for patternDateElement
ElementDefinitionpatternDateTimeSpecifies 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_patternDateTimeExtensions for patternDateTimeElement
ElementDefinitionpatternDecimalSpecifies 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_patternDecimalExtensions for patternDecimalElement
ElementDefinitionpatternIdSpecifies 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_patternIdExtensions for patternIdElement
ElementDefinitionpatternInstantSpecifies 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_patternInstantExtensions for patternInstantElement
ElementDefinitionpatternIntegerSpecifies 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_patternIntegerExtensions for patternIntegerElement
ElementDefinitionpatternInteger64Specifies 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_patternInteger64Extensions for patternInteger64Element
ElementDefinitionpatternMarkdownSpecifies 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_patternMarkdownExtensions for patternMarkdownElement
ElementDefinitionpatternOidSpecifies 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_patternOidExtensions for patternOidElement
ElementDefinitionpatternPositiveIntSpecifies 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_patternPositiveIntExtensions for patternPositiveIntElement
ElementDefinitionpatternStringSpecifies 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_patternStringExtensions for patternStringElement
ElementDefinitionpatternTimeSpecifies 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_patternTimeExtensions for patternTimeElement
ElementDefinitionpatternUnsignedIntSpecifies 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_patternUnsignedIntExtensions for patternUnsignedIntElement
ElementDefinitionpatternUriSpecifies 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_patternUriExtensions for patternUriElement
ElementDefinitionpatternUrlSpecifies 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_patternUrlExtensions for patternUrlElement
ElementDefinitionpatternUuidSpecifies 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_patternUuidExtensions for patternUuidElement
ElementDefinitionpatternAddressSpecifies 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
ElementDefinitionpatternAgeSpecifies 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
ElementDefinitionpatternAnnotationSpecifies 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
ElementDefinitionpatternAttachmentSpecifies 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
ElementDefinitionpatternCodeableConceptSpecifies 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
ElementDefinitionpatternCodingSpecifies 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
ElementDefinitionpatternContactPointSpecifies 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
ElementDefinitionpatternCountSpecifies 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
ElementDefinitionpatternDistanceSpecifies 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
ElementDefinitionpatternDurationSpecifies 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
ElementDefinitionpatternHumanNameSpecifies 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
ElementDefinitionpatternIdentifierSpecifies 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
ElementDefinitionpatternMoneySpecifies 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
ElementDefinitionpatternPeriodSpecifies 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
ElementDefinitionpatternQuantitySpecifies 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
ElementDefinitionpatternRangeSpecifies 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
ElementDefinitionpatternRatioSpecifies 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
ElementDefinitionpatternReferenceSpecifies 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
ElementDefinitionpatternSampledDataSpecifies 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
ElementDefinitionpatternSignatureSpecifies 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
ElementDefinitionpatternTimingSpecifies 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
ElementDefinitionpatternContactDetailSpecifies 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
ElementDefinitionpatternContributorSpecifies 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
ElementDefinitionpatternDataRequirementSpecifies 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
ElementDefinitionpatternExpressionSpecifies 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
ElementDefinitionpatternParameterDefinitionSpecifies 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
ElementDefinitionpatternRelatedArtifactSpecifies 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
ElementDefinitionpatternTriggerDefinitionSpecifies 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
ElementDefinitionpatternUsageContextSpecifies 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
ElementDefinitionpatternDosageSpecifies 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
ElementDefinitionpatternMetaSpecifies 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.Meta
ElementDefinitionexampleA sample value for this element demonstrating the type of information that would typically be found in the element.ElementDefinition_Example
ElementDefinitionminValueDateThe 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_minValueDateExtensions for minValueDateElement
ElementDefinitionminValueDateTimeThe 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_minValueDateTimeExtensions for minValueDateTimeElement
ElementDefinitionminValueInstantThe 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_minValueInstantExtensions for minValueInstantElement
ElementDefinitionminValueTimeThe 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_minValueTimeExtensions for minValueTimeElement
ElementDefinitionminValueDecimalThe 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_minValueDecimalExtensions for minValueDecimalElement
ElementDefinitionminValueIntegerThe 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_minValueIntegerExtensions for minValueIntegerElement
ElementDefinitionminValueInteger64The 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_minValueInteger64Extensions for minValueInteger64Element
ElementDefinitionminValuePositiveIntThe 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_minValuePositiveIntExtensions for minValuePositiveIntElement
ElementDefinitionminValueUnsignedIntThe 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_minValueUnsignedIntExtensions for minValueUnsignedIntElement
ElementDefinitionminValueQuantityThe 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
ElementDefinitionmaxValueDateThe 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_maxValueDateExtensions for maxValueDateElement
ElementDefinitionmaxValueDateTimeThe 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_maxValueDateTimeExtensions for maxValueDateTimeElement
ElementDefinitionmaxValueInstantThe 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_maxValueInstantExtensions for maxValueInstantElement
ElementDefinitionmaxValueTimeThe 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_maxValueTimeExtensions for maxValueTimeElement
ElementDefinitionmaxValueDecimalThe 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_maxValueDecimalExtensions for maxValueDecimalElement
ElementDefinitionmaxValueIntegerThe 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_maxValueIntegerExtensions for maxValueIntegerElement
ElementDefinitionmaxValueInteger64The 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_maxValueInteger64Extensions for maxValueInteger64Element
ElementDefinitionmaxValuePositiveIntThe 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_maxValuePositiveIntExtensions for maxValuePositiveIntElement
ElementDefinitionmaxValueUnsignedIntThe 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_maxValueUnsignedIntExtensions for maxValueUnsignedIntElement
ElementDefinitionmaxValueQuantityThe 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
ElementDefinitionmaxLengthIndicates 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_maxLengthExtensions for maxLengthElement
ElementDefinitionconditionA reference to an invariant that may make additional statements about the cardinality or value in the instance.id
ElementDefinition_conditionExtensions for conditionElement
ElementDefinitionconstraintFormal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.ElementDefinition_Constraint
ElementDefinitionmustSupportIf 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_mustSupportExtensions for mustSupportElement
ElementDefinitionisModifierIf 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_isModifierExtensions for isModifierElement
ElementDefinitionisModifierReasonExplains how that element affects the interpretation of the resource or element that contains it.string
ElementDefinition_isModifierReasonExtensions for isModifierReasonElement
ElementDefinitionisSummaryWhether the element should be included if a client requests a search with the parameter _summary=true.boolean
ElementDefinition_isSummaryExtensions for isSummaryElement
ElementDefinitionbindingBinds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).ElementDefinition_Binding
ElementDefinitionmappingIdentifies a concept from an external specification that roughly corresponds to this element.ElementDefinition_Mapping
ElementDefinition_BaseidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_BaseextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_BasemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_BasepathThe 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_pathExtensions for pathElement
ElementDefinition_BaseminMinimum cardinality of the base element identified by the path.unsignedInt
ElementDefinition_Base_minExtensions for minElement
ElementDefinition_BasemaxMaximum cardinality of the base element identified by the path.string
ElementDefinition_Base_maxExtensions for maxElement
ElementDefinition_BindingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_BindingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_BindingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_BindingstrengthIndicates 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_strengthExtensions for strengthElement
ElementDefinition_BindingdescriptionDescribes the intended use of this particular set of codes.string
ElementDefinition_Binding_descriptionExtensions for descriptionElement
ElementDefinition_BindingvalueSetRefers to the value set that identifies the set of codes the binding refers to.canonical
ElementDefinition_ConstraintidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_ConstraintextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ConstraintmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ConstraintkeyAllows 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_keyExtensions for keyElement
ElementDefinition_ConstraintrequirementsDescription of why this constraint is necessary or appropriate.string
ElementDefinition_Constraint_requirementsExtensions for requirementsElement
ElementDefinition_ConstraintseverityIdentifies the impact constraint violation has on the conformance of the instance.enum values:
error
warning
ElementDefinition_Constraint_severityExtensions for severityElement
ElementDefinition_ConstrainthumanText that can be used to describe the constraint in messages identifying that the constraint has been violated.string
ElementDefinition_Constraint_humanExtensions for humanElement
ElementDefinition_ConstraintexpressionA [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.string
ElementDefinition_Constraint_expressionExtensions for expressionElement
ElementDefinition_ConstraintxpathAn XPath expression of constraint that can be executed to see if this constraint is met.string
ElementDefinition_Constraint_xpathExtensions for xpathElement
ElementDefinition_ConstraintsourceA reference to the original source of the constraint, for traceability purposes.canonical
ElementDefinition_DiscriminatoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_DiscriminatorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DiscriminatormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DiscriminatortypeHow the element value is interpreted when discrimination is evaluated.enum values:
value
exists
pattern
type
profile
ElementDefinition_Discriminator_typeExtensions for typeElement
ElementDefinition_DiscriminatorpathA 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_pathExtensions for pathElement
ElementDefinition_ExampleidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_ExampleextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ExamplemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ExamplelabelDescribes the purpose of this example amoung the set of examples.string
ElementDefinition_Example_labelExtensions for labelElement
ElementDefinition_ExamplevalueBase64BinaryThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueBase64BinaryExtensions for valueBase64BinaryElement
ElementDefinition_ExamplevalueBooleanThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueBooleanExtensions for valueBooleanElement
ElementDefinition_ExamplevalueCanonicalThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueCanonicalExtensions for valueCanonicalElement
ElementDefinition_ExamplevalueCodeThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueCodeExtensions for valueCodeElement
ElementDefinition_ExamplevalueDateThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueDateExtensions for valueDateElement
ElementDefinition_ExamplevalueDateTimeThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueDateTimeExtensions for valueDateTimeElement
ElementDefinition_ExamplevalueDecimalThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueDecimalExtensions for valueDecimalElement
ElementDefinition_ExamplevalueIdThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueIdExtensions for valueIdElement
ElementDefinition_ExamplevalueInstantThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueInstantExtensions for valueInstantElement
ElementDefinition_ExamplevalueIntegerThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueIntegerExtensions for valueIntegerElement
ElementDefinition_ExamplevalueInteger64The actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueInteger64Extensions for valueInteger64Element
ElementDefinition_ExamplevalueMarkdownThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueMarkdownExtensions for valueMarkdownElement
ElementDefinition_ExamplevalueOidThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueOidExtensions for valueOidElement
ElementDefinition_ExamplevaluePositiveIntThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valuePositiveIntExtensions for valuePositiveIntElement
ElementDefinition_ExamplevalueStringThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueStringExtensions for valueStringElement
ElementDefinition_ExamplevalueTimeThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueTimeExtensions for valueTimeElement
ElementDefinition_ExamplevalueUnsignedIntThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueUnsignedIntExtensions for valueUnsignedIntElement
ElementDefinition_ExamplevalueUriThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueUriExtensions for valueUriElement
ElementDefinition_ExamplevalueUrlThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueUrlExtensions for valueUrlElement
ElementDefinition_ExamplevalueUuidThe actual value for the element, which must be one of the types allowed for this element.notDefined
ElementDefinition_Example_valueUuidExtensions for valueUuidElement
ElementDefinition_ExamplevalueAddressThe actual value for the element, which must be one of the types allowed for this element.Address
ElementDefinition_ExamplevalueAgeThe actual value for the element, which must be one of the types allowed for this element.Age
ElementDefinition_ExamplevalueAnnotationThe actual value for the element, which must be one of the types allowed for this element.Annotation
ElementDefinition_ExamplevalueAttachmentThe actual value for the element, which must be one of the types allowed for this element.Attachment
ElementDefinition_ExamplevalueCodeableConceptThe actual value for the element, which must be one of the types allowed for this element.CodeableConcept
ElementDefinition_ExamplevalueCodingThe actual value for the element, which must be one of the types allowed for this element.Coding
ElementDefinition_ExamplevalueContactPointThe actual value for the element, which must be one of the types allowed for this element.ContactPoint
ElementDefinition_ExamplevalueCountThe actual value for the element, which must be one of the types allowed for this element.Count
ElementDefinition_ExamplevalueDistanceThe actual value for the element, which must be one of the types allowed for this element.Distance
ElementDefinition_ExamplevalueDurationThe actual value for the element, which must be one of the types allowed for this element.Duration
ElementDefinition_ExamplevalueHumanNameThe actual value for the element, which must be one of the types allowed for this element.HumanName
ElementDefinition_ExamplevalueIdentifierThe actual value for the element, which must be one of the types allowed for this element.Identifier
ElementDefinition_ExamplevalueMoneyThe actual value for the element, which must be one of the types allowed for this element.Money
ElementDefinition_ExamplevaluePeriodThe actual value for the element, which must be one of the types allowed for this element.Period
ElementDefinition_ExamplevalueQuantityThe actual value for the element, which must be one of the types allowed for this element.Quantity
ElementDefinition_ExamplevalueRangeThe actual value for the element, which must be one of the types allowed for this element.Range
ElementDefinition_ExamplevalueRatioThe actual value for the element, which must be one of the types allowed for this element.Ratio
ElementDefinition_ExamplevalueReferenceThe actual value for the element, which must be one of the types allowed for this element.Reference
ElementDefinition_ExamplevalueSampledDataThe actual value for the element, which must be one of the types allowed for this element.SampledData
ElementDefinition_ExamplevalueSignatureThe actual value for the element, which must be one of the types allowed for this element.Signature
ElementDefinition_ExamplevalueTimingThe actual value for the element, which must be one of the types allowed for this element.Timing
ElementDefinition_ExamplevalueContactDetailThe actual value for the element, which must be one of the types allowed for this element.ContactDetail
ElementDefinition_ExamplevalueContributorThe actual value for the element, which must be one of the types allowed for this element.Contributor
ElementDefinition_ExamplevalueDataRequirementThe actual value for the element, which must be one of the types allowed for this element.DataRequirement
ElementDefinition_ExamplevalueExpressionThe actual value for the element, which must be one of the types allowed for this element.Expression
ElementDefinition_ExamplevalueParameterDefinitionThe actual value for the element, which must be one of the types allowed for this element.ParameterDefinition
ElementDefinition_ExamplevalueRelatedArtifactThe actual value for the element, which must be one of the types allowed for this element.RelatedArtifact
ElementDefinition_ExamplevalueTriggerDefinitionThe actual value for the element, which must be one of the types allowed for this element.TriggerDefinition
ElementDefinition_ExamplevalueUsageContextThe actual value for the element, which must be one of the types allowed for this element.UsageContext
ElementDefinition_ExamplevalueDosageThe actual value for the element, which must be one of the types allowed for this element.Dosage
ElementDefinition_ExamplevalueMetaThe actual value for the element, which must be one of the types allowed for this element.Meta
ElementDefinition_MappingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_MappingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MappingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MappingidentityAn internal reference to the definition of a mapping.id
ElementDefinition_Mapping_identityExtensions for identityElement
ElementDefinition_MappinglanguageIdentifies the computable language in which mapping.map is expressed.code
ElementDefinition_Mapping_languageExtensions for languageElement
ElementDefinition_MappingmapExpresses what part of the target specification corresponds to this element.string
ElementDefinition_Mapping_mapExtensions for mapElement
ElementDefinition_MappingcommentComments that provide information about the mapping or its use.string
ElementDefinition_Mapping_commentExtensions for commentElement
ElementDefinition_SlicingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_SlicingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SlicingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SlicingdiscriminatorDesignates 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_SlicingdescriptionA 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_descriptionExtensions for descriptionElement
ElementDefinition_SlicingorderedIf the matching elements have to occur in the same order as defined in the profile.boolean
ElementDefinition_Slicing_orderedExtensions for orderedElement
ElementDefinition_SlicingrulesWhether 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_rulesExtensions for rulesElement
ElementDefinition_TypeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ElementDefinition_TypeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TypemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TypecodeURL 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_codeExtensions for codeElement
ElementDefinition_TypeprofileIdentifies 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_TypetargetProfileUsed 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_TypeaggregationIf 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_aggregationExtensions for aggregationElement
ElementDefinition_TypeversioningWhether this reference needs to be version specific or version independent, or whether either can be used.enum values:
either
independent
specific
ElementDefinition_Type_versioningExtensions for versioningElement
EncounterresourceTypeThis is a Encounter resourceEncounter
EncounteridThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EncountermetaThe metadata about the resource. 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
EncounterimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EncounterlanguageThe base language in which the resource is written.code
Encounter_languageExtensions for languageElement
EncountertextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EncountercontainedThese 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
EncounterextensionMay be 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
EncountermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EncounteridentifierIdentifier(s) by which this encounter is known.Identifier
Encounterstatusplanned | in-progress | onhold | completed | cancelled | entered-in-error | unknown.enum values:
planned
in-progress
onhold
completed
cancelled
entered-in-error
unknown
Encounter_statusExtensions for statusElement
EncounterstatusHistoryThe 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
EncounterclassConcepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.Coding
EncounterclassHistoryThe 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
EncountertypeSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).CodeableConcept
EncounterserviceTypeBroad categorization of the service that is to be provided (e.g. cardiology).CodeableConcept
EncounterpriorityIndicates the urgency of the encounter.CodeableConcept
EncountersubjectThe patient or group present at the encounter.Reference
EncountersubjectStatusThe subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.CodeableConcept
EncounterepisodeOfCareWhere 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
EncounterbasedOnThe request this encounter satisfies (e.g. incoming referral or procedure request).Reference
EncounterparticipantThe list of people responsible for providing the service.Encounter_Participant
EncounterappointmentThe appointment that scheduled this encounter.Reference
EncounterperiodThe start and end time of the encounter.Period
EncounterlengthQuantity of time the encounter lasted. This excludes the time during leaves of absence.Duration
EncounterreasonReason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis.CodeableReference
EncounterdiagnosisThe list of diagnosis relevant to this encounter.Encounter_Diagnosis
EncounteraccountThe set of accounts that may be used for billing for this Encounter.Reference
EncounterhospitalizationDetails about the admission to a healthcare service.Encounter_Hospitalization
EncounterlocationList of locations where the patient has been during this encounter.Encounter_Location
EncounterserviceProviderThe 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
EncounterpartOfAnother Encounter of which this encounter is a part of (administratively or in time).Reference
Encounter_ClassHistoryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Encounter_ClassHistoryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ClassHistorymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ClassHistoryclassinpatient | outpatient | ambulatory | emergency +.Coding
Encounter_ClassHistoryperiodThe time that the episode was in the specified class.Period
Encounter_DiagnosisidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Encounter_DiagnosisextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DiagnosismodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DiagnosisconditionReason 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_DiagnosisuseRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …).CodeableConcept
Encounter_DiagnosisrankRanking of the diagnosis (for each role type).positiveInt
Encounter_Diagnosis_rankExtensions for rankElement
Encounter_HospitalizationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Encounter_HospitalizationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_HospitalizationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_HospitalizationpreAdmissionIdentifierPre-admission identifier.Identifier
Encounter_HospitalizationoriginThe location/organization from which the patient came before admission.Reference
Encounter_HospitalizationadmitSourceFrom where patient was admitted (physician referral, transfer).CodeableConcept
Encounter_HospitalizationreAdmissionWhether this hospitalization is a readmission and why if known.CodeableConcept
Encounter_HospitalizationdietPreferenceDiet preferences reported by the patient.CodeableConcept
Encounter_HospitalizationspecialCourtesySpecial courtesies (VIP, board member).CodeableConcept
Encounter_HospitalizationspecialArrangementAny special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.CodeableConcept
Encounter_HospitalizationdestinationLocation/organization to which the patient is discharged.Reference
Encounter_HospitalizationdischargeDispositionCategory or kind of location after discharge.CodeableConcept
Encounter_LocationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Encounter_LocationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_LocationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_LocationlocationThe location where the encounter takes place.Reference
Encounter_LocationstatusThe 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_statusExtensions for statusElement
Encounter_LocationphysicalTypeThis will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.CodeableConcept
Encounter_LocationperiodTime period during which the patient was present at the location.Period
Encounter_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Encounter_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipanttypeRole of participant in encounter.CodeableConcept
Encounter_ParticipantperiodThe 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_ParticipantindividualPersons involved in the encounter other than the patient.Reference
Encounter_StatusHistoryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Encounter_StatusHistoryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StatusHistorymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StatusHistorystatusplanned | in-progress | onhold | completed | cancelled | entered-in-error | unknown.enum values:
planned
in-progress
onhold
completed
cancelled
entered-in-error
unknown
Encounter_StatusHistory_statusExtensions for statusElement
Encounter_StatusHistoryperiodThe time that the episode was in the specified status.Period
EndpointresourceTypeThis is a Endpoint resourceEndpoint
EndpointidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EndpointmetaThe metadata about the resource. 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
EndpointimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EndpointlanguageThe base language in which the resource is written.code
Endpoint_languageExtensions for languageElement
EndpointtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EndpointcontainedThese 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
EndpointextensionMay be 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
EndpointmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EndpointidentifierIdentifier for the organization that is used to identify the endpoint across multiple disparate systems.Identifier
Endpointstatusactive | suspended | error | off | test.enum values:
active
suspended
error
off
entered-in-error
test
Endpoint_statusExtensions for statusElement
EndpointconnectionTypeA 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
EndpointnameA friendly name that this endpoint can be referred to with.string
Endpoint_nameExtensions for nameElement
EndpointmanagingOrganizationThe 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
EndpointcontactContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.ContactPoint
EndpointperiodThe interval during which the endpoint is expected to be operational.Period
EndpointpayloadTypeThe payload type describes the acceptable content that can be communicated on the endpoint.CodeableConcept
EndpointpayloadMimeTypeThe 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_payloadMimeTypeExtensions for payloadMimeTypeElement
EndpointaddressThe uri that describes the actual end-point to connect to.url
Endpoint_addressExtensions for addressElement
EndpointheaderAdditional headers / information to send as part of the notification.string
Endpoint_headerExtensions for headerElement
EnrollmentRequestresourceTypeThis is a EnrollmentRequest resourceEnrollmentRequest
EnrollmentRequestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EnrollmentRequestmetaThe metadata about the resource. 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
EnrollmentRequestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EnrollmentRequestlanguageThe base language in which the resource is written.code
EnrollmentRequest_languageExtensions for languageElement
EnrollmentRequesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EnrollmentRequestcontainedThese 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
EnrollmentRequestextensionMay be 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
EnrollmentRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EnrollmentRequestidentifierThe Response business identifier.Identifier
EnrollmentRequeststatusThe status of the resource instance.code
EnrollmentRequest_statusExtensions for statusElement
EnrollmentRequestcreatedThe date when this resource was created.dateTime
EnrollmentRequest_createdExtensions for createdElement
EnrollmentRequestinsurerThe Insurer who is target of the request.Reference
EnrollmentRequestproviderThe practitioner who is responsible for the services rendered to the patient.Reference
EnrollmentRequestcandidatePatient Resource.Reference
EnrollmentRequestcoverageReference to the program or plan identification, underwriter or payor.Reference
EnrollmentResponseresourceTypeThis is a EnrollmentResponse resourceEnrollmentResponse
EnrollmentResponseidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EnrollmentResponsemetaThe metadata about the resource. 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
EnrollmentResponseimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EnrollmentResponselanguageThe base language in which the resource is written.code
EnrollmentResponse_languageExtensions for languageElement
EnrollmentResponsetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EnrollmentResponsecontainedThese 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
EnrollmentResponseextensionMay be 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
EnrollmentResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EnrollmentResponseidentifierThe Response business identifier.Identifier
EnrollmentResponsestatusThe status of the resource instance.code
EnrollmentResponse_statusExtensions for statusElement
EnrollmentResponserequestOriginal request resource reference.Reference
EnrollmentResponseoutcomeProcessing status: error, complete.enum values:
queued
complete
error
partial
EnrollmentResponse_outcomeExtensions for outcomeElement
EnrollmentResponsedispositionA description of the status of the adjudication.string
EnrollmentResponse_dispositionExtensions for dispositionElement
EnrollmentResponsecreatedThe date when the enclosed suite of services were performed or completed.dateTime
EnrollmentResponse_createdExtensions for createdElement
EnrollmentResponseorganizationThe Insurer who produced this adjudicated response.Reference
EnrollmentResponserequestProviderThe practitioner who is responsible for the services rendered to the patient.Reference
EpisodeOfCareresourceTypeThis is a EpisodeOfCare resourceEpisodeOfCare
EpisodeOfCareidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EpisodeOfCaremetaThe metadata about the resource. 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
EpisodeOfCareimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EpisodeOfCarelanguageThe base language in which the resource is written.code
EpisodeOfCare_languageExtensions for languageElement
EpisodeOfCaretextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EpisodeOfCarecontainedThese 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
EpisodeOfCareextensionMay be 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
EpisodeOfCaremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EpisodeOfCareidentifierThe 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
EpisodeOfCarestatusplanned | waitlist | active | onhold | finished | cancelled.enum values:
planned
waitlist
active
onhold
finished
cancelled
entered-in-error
EpisodeOfCare_statusExtensions for statusElement
EpisodeOfCarestatusHistoryThe history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).EpisodeOfCare_StatusHistory
EpisodeOfCaretypeA classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.CodeableConcept
EpisodeOfCarediagnosisThe list of diagnosis relevant to this episode of care.EpisodeOfCare_Diagnosis
EpisodeOfCarepatientThe patient who is the focus of this episode of care.Reference
EpisodeOfCaremanagingOrganizationThe organization that has assumed the specific responsibilities for the specified duration.Reference
EpisodeOfCareperiodThe interval during which the managing organization assumes the defined responsibility.Period
EpisodeOfCarereferralRequestReferral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.Reference
EpisodeOfCarecareManagerThe practitioner that is the care manager/care coordinator for this patient.Reference
EpisodeOfCareteamThe list of practitioners that may be facilitating this episode of care for specific purposes.Reference
EpisodeOfCareaccountThe set of accounts that may be used for billing for this EpisodeOfCare.Reference
EpisodeOfCare_DiagnosisidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
EpisodeOfCare_DiagnosisextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DiagnosismodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DiagnosisconditionA list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.Reference
EpisodeOfCare_DiagnosisroleRole that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).CodeableConcept
EpisodeOfCare_DiagnosisrankRanking of the diagnosis (for each role type).positiveInt
EpisodeOfCare_Diagnosis_rankExtensions for rankElement
EpisodeOfCare_StatusHistoryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
EpisodeOfCare_StatusHistoryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StatusHistorymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StatusHistorystatusplanned | waitlist | active | onhold | finished | cancelled.enum values:
planned
waitlist
active
onhold
finished
cancelled
entered-in-error
EpisodeOfCare_StatusHistory_statusExtensions for statusElement
EpisodeOfCare_StatusHistoryperiodThe period during this EpisodeOfCare that the specific status applied.Period
EventDefinitionresourceTypeThis is a EventDefinition resourceEventDefinition
EventDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EventDefinitionmetaThe metadata about the resource. 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
EventDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EventDefinitionlanguageThe base language in which the resource is written.code
EventDefinition_languageExtensions for languageElement
EventDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EventDefinitioncontainedThese 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
EventDefinitionextensionMay be 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
EventDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EventDefinitionurlAn 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_urlExtensions for urlElement
EventDefinitionidentifierA 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
EventDefinitionversionThe 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_versionExtensions for versionElement
EventDefinitionnameA 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_nameExtensions for nameElement
EventDefinitiontitleA short, descriptive, user-friendly title for the event definition.string
EventDefinition_titleExtensions for titleElement
EventDefinitionstatusThe status of this event definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
EventDefinition_statusExtensions for statusElement
EventDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
EventDefinitiondateThe 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_dateExtensions for dateElement
EventDefinitionpublisherThe name of the organization or individual that published the event definition.string
EventDefinition_publisherExtensions for publisherElement
EventDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
EventDefinitiondescriptionA free text natural language description of the event definition from a consumer's perspective.markdown
EventDefinition_descriptionExtensions for descriptionElement
EventDefinitionuseContextThe 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
EventDefinitionjurisdictionA legal or geographic region in which the event definition is intended to be used.CodeableConcept
EventDefinitionpurposeExplanation of why this event definition is needed and why it has been designed as it has.markdown
EventDefinition_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
EventDefinitionapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
EventDefinition_approvalDateExtensions for approvalDateElement
EventDefinitionlastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
EventDefinition_lastReviewDateExtensions for lastReviewDateElement
EventDefinitioneffectivePeriodThe period during which the event definition content was or is planned to be in active use.Period
EventDefinitionsubtitleAn explanatory or alternate title for the event definition giving additional information about its content.string
EventDefinition_subtitleExtensions for subtitleElement
EventDefinitionsubjectCodeableConceptA code or group definition that describes the intended subject of the event definition.CodeableConcept
EventDefinitionsubjectReferenceA code or group definition that describes the intended subject of the event definition.Reference
EventDefinitionusageA detailed description of how the event definition is used from a clinical perspective.string
EventDefinition_usageExtensions for usageElement
EventDefinitiontopicDescriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.CodeableConcept
EventDefinitionauthorAn individiual or organization primarily involved in the creation and maintenance of the content.ContactDetail
EventDefinitioneditorAn individual or organization primarily responsible for internal coherence of the content.ContactDetail
EventDefinitionreviewerAn individual or organization primarily responsible for review of some aspect of the content.ContactDetail
EventDefinitionendorserAn individual or organization responsible for officially endorsing the content for use in some setting.ContactDetail
EventDefinitionrelatedArtifactRelated resources such as additional documentation, justification, or bibliographic references.RelatedArtifact
EventDefinitiontriggerThe 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
EvidenceresourceTypeThis is a Evidence resourceEvidence
EvidenceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EvidencemetaThe metadata about the resource. 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
EvidenceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EvidencelanguageThe base language in which the resource is written.code
Evidence_languageExtensions for languageElement
EvidencetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EvidencecontainedThese 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
EvidenceextensionMay be 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
EvidencemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EvidenceurlAn 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 summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.uri
Evidence_urlExtensions for urlElement
EvidenceidentifierA formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
EvidenceversionThe identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.string
Evidence_versionExtensions for versionElement
EvidencenameA natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.string
Evidence_nameExtensions for nameElement
EvidencetitleA short, descriptive, user-friendly title for the summary.string
Evidence_titleExtensions for titleElement
EvidencestatusThe status of this summary. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
Evidence_statusExtensions for statusElement
EvidenceexperimentalA Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.boolean
Evidence_experimentalExtensions for experimentalElement
EvidencedateThe date (and optionally time) when the summary 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 summary changes.dateTime
Evidence_dateExtensions for dateElement
EvidencepublisherThe name of the organization or individual that published the {{title}}.string
Evidence_publisherExtensions for publisherElement
EvidencecontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
EvidencedescriptionA free text natural language description of the evidence from a consumer's perspective.markdown
Evidence_descriptionExtensions for descriptionElement
EvidenceuseContextThe 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
EvidencejurisdictionA legal or geographic region in which the {{title}} is intended to be used.CodeableConcept
EvidencepurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
Evidence_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
EvidenceapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
Evidence_approvalDateExtensions for approvalDateElement
EvidencelastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
Evidence_lastReviewDateExtensions for lastReviewDateElement
EvidenceeffectivePeriodThe period during which the {{title}} content was or is planned to be in active use.Period
EvidencecontributorContact detail and role for contributor to summary.Contributor
EvidencerelatedArtifactLink or citation to artifact associated with the summary.RelatedArtifact
EvidenceassertionDeclarative description of the Evidence.markdown
Evidence_assertionExtensions for assertionElement
EvidencenoteFootnotes and/or explanatory notes.Annotation
EvidencevariableDefinitionEvidence variable.Evidence_VariableDefinition
EvidencesynthesisTypeThe particular type of synthesis if this is a synthesis summary.CodeableConcept
EvidencestudyTypeThe type of study that produced this summary.CodeableConcept
EvidencestatisticThe statistic value(s).Statistic
EvidencedistributionOrdered distribution.OrderedDistribution
EvidencecertaintyLevel of certainty.Evidence_Certainty
EvidenceFocusresourceTypeThis is a EvidenceFocus resourceEvidenceFocus
EvidenceFocusidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EvidenceFocusmetaThe metadata about the resource. 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
EvidenceFocusimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
EvidenceFocus_implicitRulesExtensions for implicitRulesElement
EvidenceFocuslanguageThe base language in which the resource is written.code
EvidenceFocus_languageExtensions for languageElement
EvidenceFocustextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EvidenceFocuscontainedThese 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
EvidenceFocusextensionMay be 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
EvidenceFocusmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EvidenceFocusurlAn absolute URI that is used to identify this EvidenceFocus 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 summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.uri
EvidenceFocus_urlExtensions for urlElement
EvidenceFocusidentifierA formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
EvidenceFocusversionThe identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.string
EvidenceFocus_versionExtensions for versionElement
EvidenceFocusnameA natural language name identifying the evidence focus. This name should be usable as an identifier for the module by machine processing applications such as code generation.string
EvidenceFocus_nameExtensions for nameElement
EvidenceFocustitleA short, descriptive, user-friendly title for the {{title}}.string
EvidenceFocus_titleExtensions for titleElement
EvidenceFocusstatusThe status of this summary. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
EvidenceFocus_statusExtensions for statusElement
EvidenceFocusexperimentalA Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.boolean
EvidenceFocus_experimentalExtensions for experimentalElement
EvidenceFocusdateThe date (and optionally time) when the evidence focus 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 focus changes.dateTime
EvidenceFocus_dateExtensions for dateElement
EvidenceFocuspublisherThe name of the organization or individual that published the {{title}}.string
EvidenceFocus_publisherExtensions for publisherElement
EvidenceFocuscontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
EvidenceFocusdescriptionA free text natural language description of the {{title}} from a consumer's perspective.markdown
EvidenceFocus_descriptionExtensions for descriptionElement
EvidenceFocususeContextThe 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 focus instances.UsageContext
EvidenceFocusjurisdictionA legal or geographic region in which the {{title}} is intended to be used.CodeableConcept
EvidenceFocuspurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
EvidenceFocus_purposeExtensions for purposeElement
copyrightA copyright statement relating to the evidence focus and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence focus.markdown
_copyrightExtensions for copyrightElement
EvidenceFocusapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
EvidenceFocus_approvalDateExtensions for approvalDateElement
EvidenceFocuslastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
EvidenceFocus_lastReviewDateExtensions for lastReviewDateElement
EvidenceFocuseffectivePeriodThe period during which the {{title}} content was or is planned to be in active use.Period
EvidenceFocusnoteUsed for general notes and annotations not coded elsewhere.Annotation
EvidenceFocusciteAsCitation for this EvidenceFocus resource.Reference
EvidenceFocuscharacteristicCharacteristic.EvidenceFocus_Characteristic
EvidenceFocusrelatedArtifactAdditional documentation.RelatedArtifact
EvidenceFocus_CharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
EvidenceFocus_CharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
EvidenceFocus_CharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
EvidenceFocus_CharacteristiccodeCharacteristic code.CodeableConcept
EvidenceFocus_CharacteristicvalueReferenceCharacteristic value.Reference
EvidenceFocus_CharacteristicvalueCodeableConceptCharacteristic value.CodeableConcept
EvidenceFocus_CharacteristicvalueBooleanCharacteristic value.notDefined
EvidenceFocus_Characteristic_valueBooleanExtensions for valueBooleanElement
EvidenceFocus_CharacteristicvalueQuantityCharacteristic value.Quantity
EvidenceFocus_CharacteristicvalueRangeCharacteristic value.Range
EvidenceFocus_CharacteristicexcludeIs used to express not the characteristic.boolean
EvidenceFocus_Characteristic_excludeExtensions for excludeElement
EvidenceFocus_CharacteristicperiodTimeframe for the characteristic.Period
EvidenceVariableresourceTypeThis is a EvidenceVariable resourceEvidenceVariable
EvidenceVariableidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
EvidenceVariablemetaThe metadata about the resource. 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
EvidenceVariableimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
EvidenceVariablelanguageThe base language in which the resource is written.code
EvidenceVariable_languageExtensions for languageElement
EvidenceVariabletextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
EvidenceVariablecontainedThese 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
EvidenceVariableextensionMay be 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
EvidenceVariablemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
EvidenceVariableurlAn 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_urlExtensions for urlElement
EvidenceVariableidentifierA 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
EvidenceVariableversionThe 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_versionExtensions for versionElement
EvidenceVariablenameA 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_nameExtensions for nameElement
EvidenceVariabletitleA short, descriptive, user-friendly title for the evidence variable.string
EvidenceVariable_titleExtensions for titleElement
EvidenceVariablestatusThe status of this evidence variable. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
EvidenceVariable_statusExtensions for statusElement
EvidenceVariableexperimentalA Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.boolean
EvidenceVariable_experimentalExtensions for experimentalElement
EvidenceVariabledateThe 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_dateExtensions for dateElement
EvidenceVariablepublisherThe name of the organization or individual that published the evidence variable.string
EvidenceVariable_publisherExtensions for publisherElement
EvidenceVariablecontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
EvidenceVariabledescriptionA free text natural language description of the evidence variable from a consumer's perspective.markdown
EvidenceVariable_descriptionExtensions for descriptionElement
EvidenceVariableuseContextThe 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
EvidenceVariablejurisdictionA legal or geographic region in which the evidence variable is intended to be used.CodeableConcept
EvidenceVariablepurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
EvidenceVariable_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
EvidenceVariableapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
EvidenceVariable_approvalDateExtensions for approvalDateElement
EvidenceVariablelastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
EvidenceVariable_lastReviewDateExtensions for lastReviewDateElement
EvidenceVariableeffectivePeriodThe period during which the evidence variable content was or is planned to be in active use.Period
EvidenceVariableshortTitleThe short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.string
EvidenceVariable_shortTitleExtensions for shortTitleElement
EvidenceVariablesubtitleAn explanatory or alternate title for the EvidenceVariable giving additional information about its content.string
EvidenceVariable_subtitleExtensions for subtitleElement
EvidenceVariablenoteA human-readable string to clarify or explain concepts about the resource.Annotation
EvidenceVariabletopicDescriptive 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
EvidenceVariableauthorAn individiual or organization primarily involved in the creation and maintenance of the content.ContactDetail
EvidenceVariableeditorAn individual or organization primarily responsible for internal coherence of the content.ContactDetail
EvidenceVariablereviewerAn individual or organization primarily responsible for review of some aspect of the content.ContactDetail
EvidenceVariableendorserAn individual or organization responsible for officially endorsing the content for use in some setting.ContactDetail
EvidenceVariablerelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.RelatedArtifact
EvidenceVariabletypeUsed for an outcome to classify.enum values:
dichotomous
continuous
descriptive
EvidenceVariable_typeExtensions for typeElement
EvidenceVariableactualTrue if the actual variable measured, false if a conceptual representation of the intended variable.boolean
EvidenceVariable_actualExtensions for actualElement
EvidenceVariablecharacteristicCombinationUsed to specify if two or more characteristics are combined with OR or AND.enum values:
intersection
union
EvidenceVariable_characteristicCombinationExtensions for characteristicCombinationElement
EvidenceVariablecharacteristicA characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics.EvidenceVariable_Characteristic
EvidenceVariable_CharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
EvidenceVariable_CharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CharacteristicdescriptionA short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.string
EvidenceVariable_Characteristic_descriptionExtensions for descriptionElement
EvidenceVariable_CharacteristicdefinitionReferenceDefine 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_CharacteristicdefinitionCanonicalDefine 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_definitionCanonicalExtensions for definitionCanonicalElement
EvidenceVariable_CharacteristicdefinitionCodeableConceptDefine 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_CharacteristicdefinitionExpressionDefine 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_CharacteristicmethodMethod used for describing characteristic.CodeableConcept
EvidenceVariable_CharacteristicdeviceDevice used for determining characteristic.Reference
EvidenceVariable_CharacteristicexcludeWhen true, members with this characteristic are excluded from the element.boolean
EvidenceVariable_Characteristic_excludeExtensions for excludeElement
EvidenceVariable_CharacteristictimeFromStartIndicates duration, period, or point of observation from the participant's study entry.EvidenceVariable_TimeFromStart
EvidenceVariable_CharacteristicgroupMeasureIndicates 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_groupMeasureExtensions for groupMeasureElement
EvidenceVariable_TimeFromStartidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
EvidenceVariable_TimeFromStartextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TimeFromStartmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TimeFromStartdescriptionA short, natural language description.string
EvidenceVariable_TimeFromStart_descriptionExtensions for descriptionElement
EvidenceVariable_TimeFromStartquantityUsed to express the observation at a defined amount of time after the study start.Quantity
EvidenceVariable_TimeFromStartrangeUsed to express the observation within a period after the study start.Range
EvidenceVariable_TimeFromStartnoteA human-readable string to clarify or explain concepts about the resource.Annotation
Evidence_CertaintyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Evidence_CertaintyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CertaintymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CertaintydescriptionTextual description of certainty.string
Evidence_Certainty_descriptionExtensions for descriptionElement
Evidence_CertaintynoteFootnotes and/or explanatory notes.Annotation
Evidence_CertaintyratingRating of certainty.CodeableConcept
Evidence_CertaintycertaintySubcomponentSubcomponent of certainty.Evidence_CertaintySubcomponent
Evidence_CertaintySubcomponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Evidence_CertaintySubcomponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CertaintySubcomponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CertaintySubcomponentdescriptionTextual description of certainty subcomponent.string
Evidence_CertaintySubcomponent_descriptionExtensions for descriptionElement
Evidence_CertaintySubcomponentnoteFootnotes and/or explanatory notes.Annotation
Evidence_CertaintySubcomponenttypeType of certainty being rated.CodeableConcept
Evidence_CertaintySubcomponentratingRating of certainty subcomponent.CodeableConcept
Evidence_VariableDefinitionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Evidence_VariableDefinitionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_VariableDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_VariableDefinitiondescriptionDescription of the variable.markdown
Evidence_VariableDefinition_descriptionExtensions for descriptionElement
Evidence_VariableDefinitionnoteFootnotes and/or explanatory notes.Annotation
Evidence_VariableDefinitionvariableRolepopulation | subpopulation | exposure | referenceExposure | measuredVariable | confounder.CodeableConcept
Evidence_VariableDefinitionobservedDefinition of the actual variable related to the statistic(s).Reference
Evidence_VariableDefinitionintendedDefinition of the intended variable related to the Evidence.Reference
Evidence_VariableDefinitiondirectnessMatchIndication of quality of match between intended variable to actual variable.CodeableConcept
ExampleScenarioresourceTypeThis is a ExampleScenario resourceExampleScenario
ExampleScenarioidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ExampleScenariometaThe metadata about the resource. 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
ExampleScenarioimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ExampleScenariolanguageThe base language in which the resource is written.code
ExampleScenario_languageExtensions for languageElement
ExampleScenariotextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ExampleScenariocontainedThese 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
ExampleScenarioextensionMay be 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
ExampleScenariomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ExampleScenariourlAn 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_urlExtensions for urlElement
ExampleScenarioidentifierA 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
ExampleScenarioversionThe 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_versionExtensions for versionElement
ExampleScenarionameA 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_nameExtensions for nameElement
ExampleScenariotitleA short, descriptive, user-friendly title for the {{title}}.string
ExampleScenario_titleExtensions for titleElement
ExampleScenariostatusThe status of this example scenario. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
ExampleScenario_statusExtensions for statusElement
ExampleScenarioexperimentalA 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_experimentalExtensions for experimentalElement
ExampleScenariodateThe 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_dateExtensions for dateElement
ExampleScenariopublisherThe name of the organization or individual that published the example scenario.string
ExampleScenario_publisherExtensions for publisherElement
ExampleScenariocontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ExampleScenariodescriptionA free text natural language description of the {{title}} from a consumer's perspective.markdown
ExampleScenario_descriptionExtensions for descriptionElement
ExampleScenariouseContextThe 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
ExampleScenariojurisdictionA legal or geographic region in which the example scenario is intended to be used.CodeableConcept
ExampleScenariopurposeWhat 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_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
ExampleScenarioactorActor participating in the resource.ExampleScenario_Actor
ExampleScenarioinstanceEach resource and each version that is present in the workflow.ExampleScenario_Instance
ExampleScenarioprocessEach major process - a group of operations.ExampleScenario_Process
ExampleScenarioworkflowAnother nested workflow.canonical
ExampleScenario_ActoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_ActorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ActormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ActoractorIdID or acronym of actor.string
ExampleScenario_Actor_actorIdExtensions for actorIdElement
ExampleScenario_ActortypeThe type of actor - person or system.enum values:
person
entity
ExampleScenario_Actor_typeExtensions for typeElement
ExampleScenario_ActornameThe name of the actor as shown in the page.string
ExampleScenario_Actor_nameExtensions for nameElement
ExampleScenario_ActordescriptionThe description of the actor.markdown
ExampleScenario_Actor_descriptionExtensions for descriptionElement
ExampleScenario_AlternativeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_AlternativeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AlternativemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AlternativetitleThe label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.string
ExampleScenario_Alternative_titleExtensions for titleElement
ExampleScenario_AlternativedescriptionA human-readable description of the alternative explaining when the alternative should occur rather than the base step.markdown
ExampleScenario_Alternative_descriptionExtensions for descriptionElement
ExampleScenario_AlternativestepWhat happens in each alternative option.ExampleScenario_Step
ExampleScenario_ContainedInstanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_ContainedInstanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContainedInstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContainedInstanceresourceIdEach resource contained in the instance.string
ExampleScenario_ContainedInstance_resourceIdExtensions for resourceIdElement
ExampleScenario_ContainedInstanceversionIdA specific version of a resource contained in the instance.string
ExampleScenario_ContainedInstance_versionIdExtensions for versionIdElement
ExampleScenario_InstanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_InstanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InstanceresourceIdThe id of the resource for referencing.string
ExampleScenario_Instance_resourceIdExtensions for resourceIdElement
ExampleScenario_InstanceresourceTypeThe type of the resource.code
ExampleScenario_Instance_resourceTypeExtensions for resourceTypeElement
ExampleScenario_InstancenameA short name for the resource instance.string
ExampleScenario_Instance_nameExtensions for nameElement
ExampleScenario_InstancedescriptionHuman-friendly description of the resource instance.markdown
ExampleScenario_Instance_descriptionExtensions for descriptionElement
ExampleScenario_InstanceversionA specific version of the resource.ExampleScenario_Version
ExampleScenario_InstancecontainedInstanceResources contained in the instance (e.g. the observations contained in a bundle).ExampleScenario_ContainedInstance
ExampleScenario_OperationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_OperationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OperationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OperationnumberThe sequential number of the interaction, e.g. 1.2.5.string
ExampleScenario_Operation_numberExtensions for numberElement
ExampleScenario_OperationtypeThe type of operation - CRUD.string
ExampleScenario_Operation_typeExtensions for typeElement
ExampleScenario_OperationnameThe human-friendly name of the interaction.string
ExampleScenario_Operation_nameExtensions for nameElement
ExampleScenario_OperationinitiatorWho starts the transaction.string
ExampleScenario_Operation_initiatorExtensions for initiatorElement
ExampleScenario_OperationreceiverWho receives the transaction.string
ExampleScenario_Operation_receiverExtensions for receiverElement
ExampleScenario_OperationdescriptionA comment to be inserted in the diagram.markdown
ExampleScenario_Operation_descriptionExtensions for descriptionElement
ExampleScenario_OperationinitiatorActiveWhether the initiator is deactivated right after the transaction.boolean
ExampleScenario_Operation_initiatorActiveExtensions for initiatorActiveElement
ExampleScenario_OperationreceiverActiveWhether the receiver is deactivated right after the transaction.boolean
ExampleScenario_Operation_receiverActiveExtensions for receiverActiveElement
ExampleScenario_OperationrequestEach resource instance used by the initiator.ExampleScenario_ContainedInstance
ExampleScenario_OperationresponseEach resource instance used by the responder.ExampleScenario_ContainedInstance
ExampleScenario_ProcessidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_ProcessextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProcessmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcesstitleThe diagram title of the group of operations.string
ExampleScenario_Process_titleExtensions for titleElement
ExampleScenario_ProcessdescriptionA longer description of the group of operations.markdown
ExampleScenario_Process_descriptionExtensions for descriptionElement
ExampleScenario_ProcesspreConditionsDescription of initial status before the process starts.markdown
ExampleScenario_Process_preConditionsExtensions for preConditionsElement
ExampleScenario_ProcesspostConditionsDescription of final status after the process ends.markdown
ExampleScenario_Process_postConditionsExtensions for postConditionsElement
ExampleScenario_ProcessstepEach step of the process.ExampleScenario_Step
ExampleScenario_StepidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_StepextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StepmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StepprocessNested process.ExampleScenario_Process
ExampleScenario_SteppauseIf there is a pause in the flow.boolean
ExampleScenario_Step_pauseExtensions for pauseElement
ExampleScenario_StepoperationEach interaction or action.ExampleScenario_Operation
ExampleScenario_StepalternativeIndicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.ExampleScenario_Alternative
ExampleScenario_VersionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExampleScenario_VersionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_VersionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_VersionversionIdThe identifier of a specific version of a resource.string
ExampleScenario_Version_versionIdExtensions for versionIdElement
ExampleScenario_VersiondescriptionThe description of the resource version.markdown
ExampleScenario_Version_descriptionExtensions for descriptionElement
ExplanationOfBenefitresourceTypeThis is a ExplanationOfBenefit resourceExplanationOfBenefit
ExplanationOfBenefitidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ExplanationOfBenefitmetaThe metadata about the resource. 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
ExplanationOfBenefitimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ExplanationOfBenefitlanguageThe base language in which the resource is written.code
ExplanationOfBenefit_languageExtensions for languageElement
ExplanationOfBenefittextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ExplanationOfBenefitcontainedThese 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
ExplanationOfBenefitextensionMay be 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
ExplanationOfBenefitmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ExplanationOfBenefitidentifierA unique identifier assigned to this explanation of benefit.Identifier
ExplanationOfBenefitstatusThe status of the resource instance.enum values:
active
cancelled
draft
entered-in-error
ExplanationOfBenefit_statusExtensions for statusElement
ExplanationOfBenefittypeThe category of claim, e.g. oral, pharmacy, vision, institutional, professional.CodeableConcept
ExplanationOfBenefitsubTypeA finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.CodeableConcept
ExplanationOfBenefituseA 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_useExtensions for useElement
ExplanationOfBenefitpatientThe 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
ExplanationOfBenefitbillablePeriodThe period for which charges are being submitted.Period
ExplanationOfBenefitcreatedThe date this resource was created.dateTime
ExplanationOfBenefit_createdExtensions for createdElement
ExplanationOfBenefitentererIndividual who created the claim, predetermination or preauthorization.Reference
ExplanationOfBenefitinsurerThe party responsible for authorization, adjudication and reimbursement.Reference
ExplanationOfBenefitproviderThe provider which is responsible for the claim, predetermination or preauthorization.Reference
ExplanationOfBenefitpriorityThe provider-required urgency of processing the request. Typical values include: stat, routine deferred.CodeableConcept
ExplanationOfBenefitfundsReserveRequestedA code to indicate whether and for whom funds are to be reserved for future claims.CodeableConcept
ExplanationOfBenefitfundsReserveA code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.CodeableConcept
relatedOther claims which are related to this claim such as prior submissions or claims for related services or for the same event.ExplanationOfBenefit_Related
ExplanationOfBenefitprescriptionPrescription to support the dispensing of pharmacy, device or vision products.Reference
ExplanationOfBenefitoriginalPrescriptionOriginal prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.Reference
ExplanationOfBenefitpayeeThe party to be reimbursed for cost of the products and services according to the terms of the policy.ExplanationOfBenefit_Payee
ExplanationOfBenefitreferralA reference to a referral resource.Reference
ExplanationOfBenefitfacilityFacility where the services were provided.Reference
ExplanationOfBenefitclaimThe business identifier for the instance of the adjudication request: claim predetermination or preauthorization.Reference
ExplanationOfBenefitclaimResponseThe business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.Reference
ExplanationOfBenefitoutcomeThe outcome of the claim, predetermination, or preauthorization processing.code
ExplanationOfBenefit_outcomeExtensions for outcomeElement
ExplanationOfBenefitdispositionA human readable description of the status of the adjudication.string
ExplanationOfBenefit_dispositionExtensions for dispositionElement
ExplanationOfBenefitpreAuthRefReference from the Insurer which is used in later communications which refers to this adjudication.string
ExplanationOfBenefit_preAuthRefExtensions for preAuthRefElement
ExplanationOfBenefitpreAuthRefPeriodThe timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.Period
ExplanationOfBenefitcareTeamThe members of the team who provided the products and services.ExplanationOfBenefit_CareTeam
ExplanationOfBenefitsupportingInfoAdditional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.ExplanationOfBenefit_SupportingInfo
ExplanationOfBenefitdiagnosisInformation about diagnoses relevant to the claim items.ExplanationOfBenefit_Diagnosis
ExplanationOfBenefitprocedureProcedures performed on the patient relevant to the billing items with the claim.ExplanationOfBenefit_Procedure
ExplanationOfBenefitprecedenceThis indicates the relative order of a series of EOBs related to different coverages for the same suite of services.positiveInt
ExplanationOfBenefit_precedenceExtensions for precedenceElement
ExplanationOfBenefitinsuranceFinancial instruments for reimbursement for the health care products and services specified on the claim.ExplanationOfBenefit_Insurance
ExplanationOfBenefitaccidentDetails of a accident which resulted in injuries which required the products and services listed in the claim.ExplanationOfBenefit_Accident
ExplanationOfBenefititemA 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
ExplanationOfBenefitaddItemThe first-tier service adjudications for payor added product or service lines.ExplanationOfBenefit_AddItem
ExplanationOfBenefitadjudicationThe adjudication results which are presented at the header level rather than at the line-item or add-item levels.ExplanationOfBenefit_Adjudication
ExplanationOfBenefittotalCategorized monetary totals for the adjudication.ExplanationOfBenefit_Total
ExplanationOfBenefitpaymentPayment details for the adjudication of the claim.ExplanationOfBenefit_Payment
ExplanationOfBenefitformCodeA code for the form to be used for printing the content.CodeableConcept
ExplanationOfBenefitformThe actual form, by reference or inclusion, for printing the content or an EOB.Attachment
ExplanationOfBenefitprocessNoteA note that describes or explains adjudication results in a human readable form.ExplanationOfBenefit_ProcessNote
ExplanationOfBenefitbenefitPeriodThe term of the benefits documented in this response.Period
ExplanationOfBenefitbenefitBalanceBalance by Benefit Category.ExplanationOfBenefit_BenefitBalance
ExplanationOfBenefit_AccidentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_AccidentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AccidentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AccidentdateDate of an accident event related to the products and services contained in the claim.date
ExplanationOfBenefit_Accident_dateExtensions for dateElement
ExplanationOfBenefit_AccidenttypeThe type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.CodeableConcept
ExplanationOfBenefit_AccidentlocationAddressThe physical location of the accident event.Address
ExplanationOfBenefit_AccidentlocationReferenceThe physical location of the accident event.Reference
ExplanationOfBenefit_AddItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_AddItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AddItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AddItemitemSequenceClaim items which this service line is intended to replace.positiveInt
ExplanationOfBenefit_AddItem_itemSequenceExtensions for itemSequenceElement
ExplanationOfBenefit_AddItemdetailSequenceThe sequence number of the details within the claim item which this line is intended to replace.positiveInt
ExplanationOfBenefit_AddItem_detailSequenceExtensions for detailSequenceElement
ExplanationOfBenefit_AddItemsubDetailSequenceThe sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.positiveInt
ExplanationOfBenefit_AddItem_subDetailSequenceExtensions for subDetailSequenceElement
ExplanationOfBenefit_AddItemproviderThe providers who are authorized for the services rendered to the patient.Reference
ExplanationOfBenefit_AddItemproductOrServiceWhen 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_AddItemmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ExplanationOfBenefit_AddItemprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
ExplanationOfBenefit_AddItemservicedDateThe date or dates when the service or product was supplied, performed or completed.notDefined
ExplanationOfBenefit_AddItem_servicedDateExtensions for servicedDateElement
ExplanationOfBenefit_AddItemservicedPeriodThe date or dates when the service or product was supplied, performed or completed.Period
ExplanationOfBenefit_AddItemlocationCodeableConceptWhere the product or service was provided.CodeableConcept
ExplanationOfBenefit_AddItemlocationAddressWhere the product or service was provided.Address
ExplanationOfBenefit_AddItemlocationReferenceWhere the product or service was provided.Reference
ExplanationOfBenefit_AddItemquantityThe number of repetitions of a service or product.Quantity
ExplanationOfBenefit_AddItemunitPriceIf 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_AddItemfactorA 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_factorExtensions for factorElement
ExplanationOfBenefit_AddItemnetThe quantity times the unit price for an additional service or product or charge.Money
ExplanationOfBenefit_AddItembodySitePhysical service site on the patient (limb, tooth, etc.).CodeableConcept
ExplanationOfBenefit_AddItemsubSiteA region or surface of the bodySite, e.g. limb region or tooth surface(s).CodeableConcept
ExplanationOfBenefit_AddItemnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ExplanationOfBenefit_AddItem_noteNumberExtensions for noteNumberElement
ExplanationOfBenefit_AddItemadjudicationThe adjudication results.ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_AddItemdetailThe second-tier service adjudications for payor added services.ExplanationOfBenefit_Detail1
ExplanationOfBenefit_AdjudicationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_AdjudicationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AdjudicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AdjudicationcategoryA 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_AdjudicationreasonA code supporting the understanding of the adjudication result and explaining variance from expected amount.CodeableConcept
ExplanationOfBenefit_AdjudicationamountMonetary amount associated with the category.Money
ExplanationOfBenefit_AdjudicationvalueA non-monetary value associated with the category. Mutually exclusive to the amount element above.decimal
ExplanationOfBenefit_Adjudication_valueExtensions for valueElement
ExplanationOfBenefit_BenefitBalanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_BenefitBalanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_BenefitBalancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_BenefitBalancecategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
ExplanationOfBenefit_BenefitBalanceexcludedTrue 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_excludedExtensions for excludedElement
ExplanationOfBenefit_BenefitBalancenameA short name or tag for the benefit.string
ExplanationOfBenefit_BenefitBalance_nameExtensions for nameElement
ExplanationOfBenefit_BenefitBalancedescriptionA richer description of the benefit or services covered.string
ExplanationOfBenefit_BenefitBalance_descriptionExtensions for descriptionElement
ExplanationOfBenefit_BenefitBalancenetworkIs a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.CodeableConcept
ExplanationOfBenefit_BenefitBalanceunitIndicates if the benefits apply to an individual or to the family.CodeableConcept
ExplanationOfBenefit_BenefitBalancetermThe term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.CodeableConcept
ExplanationOfBenefit_BenefitBalancefinancialBenefits Used to date.ExplanationOfBenefit_Financial
ExplanationOfBenefit_CareTeamidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_CareTeamextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CareTeammodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CareTeamsequenceA number to uniquely identify care team entries.positiveInt
ExplanationOfBenefit_CareTeam_sequenceExtensions for sequenceElement
ExplanationOfBenefit_CareTeamproviderMember of the team who provided the product or service.Reference
ExplanationOfBenefit_CareTeamresponsibleThe party who is billing and/or responsible for the claimed products or services.boolean
ExplanationOfBenefit_CareTeam_responsibleExtensions for responsibleElement
ExplanationOfBenefit_CareTeamroleThe lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.CodeableConcept
ExplanationOfBenefit_CareTeamqualificationThe qualification of the practitioner which is applicable for this service.CodeableConcept
ExplanationOfBenefit_DetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_DetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DetailsequenceA claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.positiveInt
ExplanationOfBenefit_Detail_sequenceExtensions for sequenceElement
ExplanationOfBenefit_DetailrevenueThe type of revenue or cost center providing the product and/or service.CodeableConcept
ExplanationOfBenefit_DetailcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
ExplanationOfBenefit_DetailproductOrServiceWhen 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_DetailmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ExplanationOfBenefit_DetailprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
ExplanationOfBenefit_DetailquantityThe number of repetitions of a service or product.Quantity
ExplanationOfBenefit_DetailunitPriceIf 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_DetailfactorA 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_factorExtensions for factorElement
ExplanationOfBenefit_DetailnetThe quantity times the unit price for an additional service or product or charge.Money
ExplanationOfBenefit_DetailudiUnique Device Identifiers associated with this line item.Reference
ExplanationOfBenefit_DetailnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ExplanationOfBenefit_Detail_noteNumberExtensions for noteNumberElement
ExplanationOfBenefit_DetailadjudicationThe adjudication results.ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_DetailsubDetailThird-tier of goods and services.ExplanationOfBenefit_SubDetail
ExplanationOfBenefit_Detail1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_Detail1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Detail1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Detail1productOrServiceWhen 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_Detail1modifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ExplanationOfBenefit_Detail1quantityThe number of repetitions of a service or product.Quantity
ExplanationOfBenefit_Detail1unitPriceIf 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_Detail1factorA 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_factorExtensions for factorElement
ExplanationOfBenefit_Detail1netThe quantity times the unit price for an additional service or product or charge.Money
ExplanationOfBenefit_Detail1noteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ExplanationOfBenefit_Detail1_noteNumberExtensions for noteNumberElement
ExplanationOfBenefit_Detail1adjudicationThe adjudication results.ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_Detail1subDetailThe third-tier service adjudications for payor added services.ExplanationOfBenefit_SubDetail1
ExplanationOfBenefit_DiagnosisidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_DiagnosisextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DiagnosismodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DiagnosissequenceA number to uniquely identify diagnosis entries.positiveInt
ExplanationOfBenefit_Diagnosis_sequenceExtensions for sequenceElement
ExplanationOfBenefit_DiagnosisdiagnosisCodeableConceptThe nature of illness or problem in a coded form or as a reference to an external defined Condition.CodeableConcept
ExplanationOfBenefit_DiagnosisdiagnosisReferenceThe nature of illness or problem in a coded form or as a reference to an external defined Condition.Reference
ExplanationOfBenefit_DiagnosistypeWhen the condition was observed or the relative ranking.CodeableConcept
ExplanationOfBenefit_DiagnosisonAdmissionIndication of whether the diagnosis was present on admission to a facility.CodeableConcept
ExplanationOfBenefit_DiagnosispackageCodeA 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_FinancialidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_FinancialextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FinancialmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FinancialtypeClassification of benefit being provided.CodeableConcept
ExplanationOfBenefit_FinancialallowedUnsignedIntThe quantity of the benefit which is permitted under the coverage.notDefined
ExplanationOfBenefit_Financial_allowedUnsignedIntExtensions for allowedUnsignedIntElement
ExplanationOfBenefit_FinancialallowedStringThe quantity of the benefit which is permitted under the coverage.notDefined
ExplanationOfBenefit_Financial_allowedStringExtensions for allowedStringElement
ExplanationOfBenefit_FinancialallowedMoneyThe quantity of the benefit which is permitted under the coverage.Money
ExplanationOfBenefit_FinancialusedUnsignedIntThe quantity of the benefit which have been consumed to date.notDefined
ExplanationOfBenefit_Financial_usedUnsignedIntExtensions for usedUnsignedIntElement
ExplanationOfBenefit_FinancialusedMoneyThe quantity of the benefit which have been consumed to date.Money
ExplanationOfBenefit_InsuranceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_InsuranceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InsurancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InsurancefocalA flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.boolean
ExplanationOfBenefit_Insurance_focalExtensions for focalElement
ExplanationOfBenefit_InsurancecoverageReference 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_InsurancepreAuthRefReference 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_preAuthRefExtensions for preAuthRefElement
ExplanationOfBenefit_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemsequenceA number to uniquely identify item entries.positiveInt
ExplanationOfBenefit_Item_sequenceExtensions for sequenceElement
ExplanationOfBenefit_ItemcareTeamSequenceCare team members related to this service or product.positiveInt
ExplanationOfBenefit_Item_careTeamSequenceExtensions for careTeamSequenceElement
ExplanationOfBenefit_ItemdiagnosisSequenceDiagnoses applicable for this service or product.positiveInt
ExplanationOfBenefit_Item_diagnosisSequenceExtensions for diagnosisSequenceElement
ExplanationOfBenefit_ItemprocedureSequenceProcedures applicable for this service or product.positiveInt
ExplanationOfBenefit_Item_procedureSequenceExtensions for procedureSequenceElement
ExplanationOfBenefit_IteminformationSequenceExceptions, special conditions and supporting information applicable for this service or product.positiveInt
ExplanationOfBenefit_Item_informationSequenceExtensions for informationSequenceElement
ExplanationOfBenefit_ItemrevenueThe type of revenue or cost center providing the product and/or service.CodeableConcept
ExplanationOfBenefit_ItemcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
ExplanationOfBenefit_ItemproductOrServiceWhen 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_ItemmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ExplanationOfBenefit_ItemprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
ExplanationOfBenefit_ItemservicedDateThe date or dates when the service or product was supplied, performed or completed.notDefined
ExplanationOfBenefit_Item_servicedDateExtensions for servicedDateElement
ExplanationOfBenefit_ItemservicedPeriodThe date or dates when the service or product was supplied, performed or completed.Period
ExplanationOfBenefit_ItemlocationCodeableConceptWhere the product or service was provided.CodeableConcept
ExplanationOfBenefit_ItemlocationAddressWhere the product or service was provided.Address
ExplanationOfBenefit_ItemlocationReferenceWhere the product or service was provided.Reference
ExplanationOfBenefit_ItemquantityThe number of repetitions of a service or product.Quantity
ExplanationOfBenefit_ItemunitPriceIf 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_ItemfactorA 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_factorExtensions for factorElement
ExplanationOfBenefit_ItemnetThe quantity times the unit price for an additional service or product or charge.Money
ExplanationOfBenefit_ItemudiUnique Device Identifiers associated with this line item.Reference
ExplanationOfBenefit_ItembodySitePhysical service site on the patient (limb, tooth, etc.).CodeableConcept
ExplanationOfBenefit_ItemsubSiteA region or surface of the bodySite, e.g. limb region or tooth surface(s).CodeableConcept
ExplanationOfBenefit_ItemencounterA billed item may include goods or services provided in multiple encounters.Reference
ExplanationOfBenefit_ItemnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ExplanationOfBenefit_Item_noteNumberExtensions for noteNumberElement
ExplanationOfBenefit_ItemadjudicationIf 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_ItemdetailSecond-tier of goods and services.ExplanationOfBenefit_Detail
ExplanationOfBenefit_PayeeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_PayeeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PayeemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PayeetypeType of Party to be reimbursed: Subscriber, provider, other.CodeableConcept
ExplanationOfBenefit_PayeepartyReference to the individual or organization to whom any payment will be made.Reference
ExplanationOfBenefit_PaymentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_PaymentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PaymentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PaymenttypeWhether this represents partial or complete payment of the benefits payable.CodeableConcept
ExplanationOfBenefit_PaymentadjustmentTotal amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.Money
ExplanationOfBenefit_PaymentadjustmentReasonReason for the payment adjustment.CodeableConcept
ExplanationOfBenefit_PaymentdateEstimated date the payment will be issued or the actual issue date of payment.date
ExplanationOfBenefit_Payment_dateExtensions for dateElement
ExplanationOfBenefit_PaymentamountBenefits payable less any payment adjustment.Money
ExplanationOfBenefit_PaymentidentifierIssuer's unique identifier for the payment instrument.Identifier
ExplanationOfBenefit_ProcedureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_ProcedureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProceduremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProceduresequenceA number to uniquely identify procedure entries.positiveInt
ExplanationOfBenefit_Procedure_sequenceExtensions for sequenceElement
ExplanationOfBenefit_ProceduretypeWhen the condition was observed or the relative ranking.CodeableConcept
ExplanationOfBenefit_ProceduredateDate and optionally time the procedure was performed.dateTime
ExplanationOfBenefit_Procedure_dateExtensions for dateElement
ExplanationOfBenefit_ProcedureprocedureCodeableConceptThe code or reference to a Procedure resource which identifies the clinical intervention performed.CodeableConcept
ExplanationOfBenefit_ProcedureprocedureReferenceThe code or reference to a Procedure resource which identifies the clinical intervention performed.Reference
ExplanationOfBenefit_ProcedureudiUnique Device Identifiers associated with this line item.Reference
ExplanationOfBenefit_ProcessNoteidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_ProcessNoteextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProcessNotemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcessNotenumberA number to uniquely identify a note entry.positiveInt
ExplanationOfBenefit_ProcessNote_numberExtensions for numberElement
ExplanationOfBenefit_ProcessNotetypeThe business purpose of the note text.enum values:
display
print
printoper
ExplanationOfBenefit_ProcessNote_typeExtensions for typeElement
ExplanationOfBenefit_ProcessNotetextThe explanation or description associated with the processing.string
ExplanationOfBenefit_ProcessNote_textExtensions for textElement
ExplanationOfBenefit_ProcessNotelanguageA code to define the language used in the text of the note.CodeableConcept
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
claimReference to a related claim.Reference
relationshipA code to convey how the claims are related.CodeableConcept
referenceAn alternate organizational reference to the case or file to which this particular claim pertains.Identifier
ExplanationOfBenefit_SubDetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_SubDetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubDetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubDetailsequenceA claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.positiveInt
ExplanationOfBenefit_SubDetail_sequenceExtensions for sequenceElement
ExplanationOfBenefit_SubDetailrevenueThe type of revenue or cost center providing the product and/or service.CodeableConcept
ExplanationOfBenefit_SubDetailcategoryCode to identify the general type of benefits under which products and services are provided.CodeableConcept
ExplanationOfBenefit_SubDetailproductOrServiceWhen 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_SubDetailmodifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ExplanationOfBenefit_SubDetailprogramCodeIdentifies the program under which this may be recovered.CodeableConcept
ExplanationOfBenefit_SubDetailquantityThe number of repetitions of a service or product.Quantity
ExplanationOfBenefit_SubDetailunitPriceIf 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_SubDetailfactorA 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_factorExtensions for factorElement
ExplanationOfBenefit_SubDetailnetThe quantity times the unit price for an additional service or product or charge.Money
ExplanationOfBenefit_SubDetailudiUnique Device Identifiers associated with this line item.Reference
ExplanationOfBenefit_SubDetailnoteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ExplanationOfBenefit_SubDetail_noteNumberExtensions for noteNumberElement
ExplanationOfBenefit_SubDetailadjudicationThe adjudication results.ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_SubDetail1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_SubDetail1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubDetail1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubDetail1productOrServiceWhen 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_SubDetail1modifierItem typification or modifiers codes to convey additional context for the product or service.CodeableConcept
ExplanationOfBenefit_SubDetail1quantityThe number of repetitions of a service or product.Quantity
ExplanationOfBenefit_SubDetail1unitPriceIf 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_SubDetail1factorA 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_factorExtensions for factorElement
ExplanationOfBenefit_SubDetail1netThe quantity times the unit price for an additional service or product or charge.Money
ExplanationOfBenefit_SubDetail1noteNumberThe numbers associated with notes below which apply to the adjudication of this item.positiveInt
ExplanationOfBenefit_SubDetail1_noteNumberExtensions for noteNumberElement
ExplanationOfBenefit_SubDetail1adjudicationThe adjudication results.ExplanationOfBenefit_Adjudication
ExplanationOfBenefit_SupportingInfoidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_SupportingInfoextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SupportingInfomodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SupportingInfosequenceA number to uniquely identify supporting information entries.positiveInt
ExplanationOfBenefit_SupportingInfo_sequenceExtensions for sequenceElement
ExplanationOfBenefit_SupportingInfocategoryThe general class of the information supplied: information; exception; accident, employment; onset, etc.CodeableConcept
ExplanationOfBenefit_SupportingInfocodeSystem and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.CodeableConcept
ExplanationOfBenefit_SupportingInfotimingDateThe date when or period to which this information refers.notDefined
ExplanationOfBenefit_SupportingInfo_timingDateExtensions for timingDateElement
ExplanationOfBenefit_SupportingInfotimingPeriodThe date when or period to which this information refers.Period
ExplanationOfBenefit_SupportingInfovalueBooleanAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.notDefined
ExplanationOfBenefit_SupportingInfo_valueBooleanExtensions for valueBooleanElement
ExplanationOfBenefit_SupportingInfovalueStringAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.notDefined
ExplanationOfBenefit_SupportingInfo_valueStringExtensions for valueStringElement
ExplanationOfBenefit_SupportingInfovalueQuantityAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Quantity
ExplanationOfBenefit_SupportingInfovalueAttachmentAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Attachment
ExplanationOfBenefit_SupportingInfovalueReferenceAdditional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.Reference
ExplanationOfBenefit_SupportingInforeasonProvides the reason in the situation where a reason code is required in addition to the content.Coding
ExplanationOfBenefit_TotalidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExplanationOfBenefit_TotalextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TotalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TotalcategoryA 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_TotalamountMonetary total amount associated with the category.Money
ExpressionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExpressionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ExpressiondescriptionA brief, natural language description of the condition that effectively communicates the intended semantics.string
Expression_descriptionExtensions for descriptionElement
ExpressionnameA short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.id
Expression_nameExtensions for nameElement
ExpressionlanguageThe media type of the language for the expression.enum values:
text/cql
text/fhirpath
application/x-fhir-query
Expression_languageExtensions for languageElement
ExpressionexpressionAn expression in the specified language that returns a value.string
Expression_expressionExtensions for expressionElement
ExpressionreferenceA URI that defines where the expression is found.uri
Expression_referenceExtensions for referenceElement
ExtensionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ExtensionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ExtensionurlSource of the definition for the extension code - a logical name or a URL.uri
Extension_urlExtensions for urlElement
ExtensionvalueBase64BinaryValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueBase64BinaryExtensions for valueBase64BinaryElement
ExtensionvalueBooleanValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueBooleanExtensions for valueBooleanElement
ExtensionvalueCanonicalValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueCanonicalExtensions for valueCanonicalElement
ExtensionvalueCodeValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueCodeExtensions for valueCodeElement
ExtensionvalueDateValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueDateExtensions for valueDateElement
ExtensionvalueDateTimeValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueDateTimeExtensions for valueDateTimeElement
ExtensionvalueDecimalValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueDecimalExtensions for valueDecimalElement
ExtensionvalueIdValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueIdExtensions for valueIdElement
ExtensionvalueInstantValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueInstantExtensions for valueInstantElement
ExtensionvalueIntegerValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueIntegerExtensions for valueIntegerElement
ExtensionvalueInteger64Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueInteger64Extensions for valueInteger64Element
ExtensionvalueMarkdownValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueMarkdownExtensions for valueMarkdownElement
ExtensionvalueOidValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueOidExtensions for valueOidElement
ExtensionvaluePositiveIntValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valuePositiveIntExtensions for valuePositiveIntElement
ExtensionvalueStringValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueStringExtensions for valueStringElement
ExtensionvalueTimeValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueTimeExtensions for valueTimeElement
ExtensionvalueUnsignedIntValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueUnsignedIntExtensions for valueUnsignedIntElement
ExtensionvalueUriValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueUriExtensions for valueUriElement
ExtensionvalueUrlValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueUrlExtensions for valueUrlElement
ExtensionvalueUuidValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).notDefined
Extension_valueUuidExtensions for valueUuidElement
ExtensionvalueAddressValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Address
ExtensionvalueAgeValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Age
ExtensionvalueAnnotationValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Annotation
ExtensionvalueAttachmentValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Attachment
ExtensionvalueCodeableConceptValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).CodeableConcept
ExtensionvalueCodingValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Coding
ExtensionvalueContactPointValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).ContactPoint
ExtensionvalueCountValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Count
ExtensionvalueDistanceValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Distance
ExtensionvalueDurationValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Duration
ExtensionvalueHumanNameValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).HumanName
ExtensionvalueIdentifierValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Identifier
ExtensionvalueMoneyValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Money
ExtensionvaluePeriodValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Period
ExtensionvalueQuantityValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Quantity
ExtensionvalueRangeValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Range
ExtensionvalueRatioValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Ratio
ExtensionvalueReferenceValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Reference
ExtensionvalueSampledDataValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).SampledData
ExtensionvalueSignatureValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Signature
ExtensionvalueTimingValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Timing
ExtensionvalueContactDetailValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).ContactDetail
ExtensionvalueContributorValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Contributor
ExtensionvalueDataRequirementValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).DataRequirement
ExtensionvalueExpressionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Expression
ExtensionvalueParameterDefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).ParameterDefinition
ExtensionvalueRelatedArtifactValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).RelatedArtifact
ExtensionvalueTriggerDefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).TriggerDefinition
ExtensionvalueUsageContextValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).UsageContext
ExtensionvalueDosageValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Dosage
ExtensionvalueMetaValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).Meta
FamilyMemberHistoryresourceTypeThis is a FamilyMemberHistory resourceFamilyMemberHistory
FamilyMemberHistoryidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
FamilyMemberHistorymetaThe metadata about the resource. 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
FamilyMemberHistoryimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
FamilyMemberHistorylanguageThe base language in which the resource is written.code
FamilyMemberHistory_languageExtensions for languageElement
FamilyMemberHistorytextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
FamilyMemberHistorycontainedThese 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
FamilyMemberHistoryextensionMay be 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
FamilyMemberHistorymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
FamilyMemberHistoryidentifierBusiness 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
FamilyMemberHistoryinstantiatesCanonicalThe 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
FamilyMemberHistoryinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
FamilyMemberHistorystatusA 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_statusExtensions for statusElement
FamilyMemberHistorydataAbsentReasonDescribes why the family member's history is not available.CodeableConcept
FamilyMemberHistorypatientThe person who this history concerns.Reference
FamilyMemberHistorydateThe date (and possibly time) when the family member history was recorded or last updated.dateTime
FamilyMemberHistory_dateExtensions for dateElement
FamilyMemberHistorynameThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".string
FamilyMemberHistory_nameExtensions for nameElement
FamilyMemberHistoryrelationshipThe type of relationship this person has to the patient (father, mother, brother etc.).CodeableConcept
FamilyMemberHistorysexThe birth sex of the family member.CodeableConcept
FamilyMemberHistorybornPeriodThe actual or approximate date of birth of the relative.Period
FamilyMemberHistorybornDateThe actual or approximate date of birth of the relative.notDefined
FamilyMemberHistory_bornDateExtensions for bornDateElement
FamilyMemberHistorybornStringThe actual or approximate date of birth of the relative.notDefined
FamilyMemberHistory_bornStringExtensions for bornStringElement
FamilyMemberHistoryageAgeThe age of the relative at the time the family member history is recorded.Age
FamilyMemberHistoryageRangeThe age of the relative at the time the family member history is recorded.Range
FamilyMemberHistoryageStringThe age of the relative at the time the family member history is recorded.notDefined
FamilyMemberHistory_ageStringExtensions for ageStringElement
FamilyMemberHistoryestimatedAgeIf true, indicates that the age value specified is an estimated value.boolean
FamilyMemberHistory_estimatedAgeExtensions for estimatedAgeElement
FamilyMemberHistorydeceasedBooleanDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.notDefined
FamilyMemberHistory_deceasedBooleanExtensions for deceasedBooleanElement
FamilyMemberHistorydeceasedAgeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.Age
FamilyMemberHistorydeceasedRangeDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.Range
FamilyMemberHistorydeceasedDateDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.notDefined
FamilyMemberHistory_deceasedDateExtensions for deceasedDateElement
FamilyMemberHistorydeceasedStringDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.notDefined
FamilyMemberHistory_deceasedStringExtensions for deceasedStringElement
FamilyMemberHistoryreasonDescribes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.CodeableReference
FamilyMemberHistorynoteThis 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
FamilyMemberHistoryconditionThe 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
FamilyMemberHistoryprocedureThe significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.FamilyMemberHistory_Procedure
FamilyMemberHistory_ConditionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
FamilyMemberHistory_ConditionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ConditionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ConditioncodeThe 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_ConditionoutcomeIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.CodeableConcept
FamilyMemberHistory_ConditioncontributedToDeathThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.boolean
FamilyMemberHistory_Condition_contributedToDeathExtensions for contributedToDeathElement
FamilyMemberHistory_ConditiononsetAgeEither 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_ConditiononsetRangeEither 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_ConditiononsetPeriodEither 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_ConditiononsetStringEither 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_onsetStringExtensions for onsetStringElement
FamilyMemberHistory_ConditionnoteAn area where general notes can be placed about this specific condition.Annotation
FamilyMemberHistory_ProcedureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
FamilyMemberHistory_ProcedureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProceduremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcedurecodeThe actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system.CodeableConcept
FamilyMemberHistory_ProcedureoutcomeIndicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.CodeableConcept
FamilyMemberHistory_ProcedurecontributedToDeathThis procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.boolean
FamilyMemberHistory_Procedure_contributedToDeathExtensions for contributedToDeathElement
FamilyMemberHistory_ProcedureperformedAgeEstimated 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
FamilyMemberHistory_ProcedureperformedRangeEstimated 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
FamilyMemberHistory_ProcedureperformedPeriodEstimated 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
FamilyMemberHistory_ProcedureperformedStringEstimated 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
FamilyMemberHistory_Procedure_performedStringExtensions for performedStringElement
FamilyMemberHistory_ProcedureperformedDateTimeEstimated 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
FamilyMemberHistory_Procedure_performedDateTimeExtensions for performedDateTimeElement
FamilyMemberHistory_ProcedurenoteAn area where general notes can be placed about this specific procedure.Annotation
FlagresourceTypeThis is a Flag resourceFlag
FlagidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
FlagmetaThe metadata about the resource. 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
FlagimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
FlaglanguageThe base language in which the resource is written.code
Flag_languageExtensions for languageElement
FlagtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
FlagcontainedThese 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
FlagextensionMay be 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
FlagmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
FlagidentifierBusiness 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
FlagstatusSupports basic workflow.enum values:
active
inactive
entered-in-error
Flag_statusExtensions for statusElement
FlagcategoryAllows 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
FlagcodeThe coded value or textual component of the flag to display to the user.CodeableConcept
FlagsubjectThe patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.Reference
FlagperiodThe 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
FlagencounterThis alert is only relevant during the encounter.Reference
FlagauthorThe person, organization or device that created the flag.Reference
GoalresourceTypeThis is a Goal resourceGoal
GoalidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
GoalmetaThe metadata about the resource. 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
GoalimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
GoallanguageThe base language in which the resource is written.code
Goal_languageExtensions for languageElement
GoaltextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
GoalcontainedThese 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
GoalextensionMay be 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
GoalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
GoalidentifierBusiness 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
GoallifecycleStatusThe state of the goal throughout its lifecycle.enum values:
proposed
planned
accepted
active
on-hold
completed
cancelled
entered-in-error
rejected
Goal_lifecycleStatusExtensions for lifecycleStatusElement
GoalachievementStatusDescribes the progression, or lack thereof, towards the goal against the target.CodeableConcept
GoalcategoryIndicates a category the goal falls within.CodeableConcept
GoalcontinuousAfter meeting the goal, ongoing activity is needed to sustain the goal objective.boolean
Goal_continuousExtensions for continuousElement
GoalpriorityIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.CodeableConcept
GoaldescriptionHuman-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
GoalsubjectIdentifies the patient, group or organization for whom the goal is being established.Reference
GoalstartDateThe date or event after which the goal should begin being pursued.notDefined
Goal_startDateExtensions for startDateElement
GoalstartCodeableConceptThe date or event after which the goal should begin being pursued.CodeableConcept
GoaltargetIndicates what should be done by when.Goal_Target
GoalstatusDateIdentifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.date
Goal_statusDateExtensions for statusDateElement
GoalstatusReasonCaptures the reason for the current status.string
Goal_statusReasonExtensions for statusReasonElement
GoalexpressedByIndicates whose goal this is - patient goal, practitioner goal, etc.Reference
GoaladdressesThe identified conditions and other health record elements that are intended to be addressed by the goal.Reference
GoalnoteAny comments related to the goal.Annotation
GoaloutcomeIdentifies the change (or lack of change) at the point when the status of the goal is assessed.CodeableReference
Goal_TargetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Goal_TargetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TargetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TargetmeasureThe parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.CodeableConcept
Goal_TargetdetailQuantityThe 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_TargetdetailRangeThe 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_TargetdetailCodeableConceptThe 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_TargetdetailStringThe 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_detailStringExtensions for detailStringElement
Goal_TargetdetailBooleanThe 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_detailBooleanExtensions for detailBooleanElement
Goal_TargetdetailIntegerThe 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_detailIntegerExtensions for detailIntegerElement
Goal_TargetdetailRatioThe 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_TargetdueDateIndicates either the date or the duration after start by which the goal should be met.notDefined
Goal_Target_dueDateExtensions for dueDateElement
Goal_TargetdueDurationIndicates either the date or the duration after start by which the goal should be met.Duration
GraphDefinitionresourceTypeThis is a GraphDefinition resourceGraphDefinition
GraphDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
GraphDefinitionmetaThe metadata about the resource. 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
GraphDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
GraphDefinitionlanguageThe base language in which the resource is written.code
GraphDefinition_languageExtensions for languageElement
GraphDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
GraphDefinitioncontainedThese 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
GraphDefinitionextensionMay be 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
GraphDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
GraphDefinitionurlAn 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_urlExtensions for urlElement
GraphDefinitionidentifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
GraphDefinitionversionThe 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_versionExtensions for versionElement
GraphDefinitionnameA 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_nameExtensions for nameElement
GraphDefinitiontitleA short, descriptive, user-friendly title for the {{title}}.string
GraphDefinition_titleExtensions for titleElement
GraphDefinitionstatusThe status of this graph definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
GraphDefinition_statusExtensions for statusElement
GraphDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
GraphDefinitiondateThe 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_dateExtensions for dateElement
GraphDefinitionpublisherThe name of the organization or individual that published the graph definition.string
GraphDefinition_publisherExtensions for publisherElement
GraphDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
GraphDefinitiondescriptionA free text natural language description of the graph definition from a consumer's perspective.markdown
GraphDefinition_descriptionExtensions for descriptionElement
GraphDefinitionuseContextThe 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
GraphDefinitionjurisdictionA legal or geographic region in which the graph definition is intended to be used.CodeableConcept
GraphDefinitionpurposeExplanation of why this graph definition is needed and why it has been designed as it has.markdown
GraphDefinition_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
GraphDefinitionstartThe type of FHIR resource at which instances of this graph start.code
GraphDefinition_startExtensions for startElement
GraphDefinitionprofileThe profile that describes the use of the base resource.canonical
linkLinks this graph makes rules about.GraphDefinition_Link
GraphDefinition_CompartmentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
GraphDefinition_CompartmentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CompartmentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CompartmentuseDefines 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_useExtensions for useElement
GraphDefinition_CompartmentcodeIdentifies the compartment.code
GraphDefinition_Compartment_codeExtensions for codeElement
GraphDefinition_Compartmentruleidentical | matching | different | no-rule | custom.enum values:
identical
matching
different
custom
GraphDefinition_Compartment_ruleExtensions for ruleElement
GraphDefinition_CompartmentexpressionCustom rule, as a FHIRPath expression.string
GraphDefinition_Compartment_expressionExtensions for expressionElement
GraphDefinition_CompartmentdescriptionDocumentation for FHIRPath expression.string
GraphDefinition_Compartment_descriptionExtensions for descriptionElement
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
pathA FHIR expression that identifies one of FHIR References to other resources.string
_pathExtensions for pathElement
sliceNameWhich slice (if profiled).string
_sliceNameExtensions for sliceNameElement
minMinimum occurrences for this link.integer
_minExtensions for minElement
maxMaximum occurrences for this link.string
_maxExtensions for maxElement
descriptionInformation about why this link is of interest in this graph definition.string
_descriptionExtensions for descriptionElement
targetPotential target for the link.GraphDefinition_Target
GraphDefinition_TargetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
GraphDefinition_TargetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TargetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TargettypeType of resource this link refers to.code
GraphDefinition_Target_typeExtensions for typeElement
GraphDefinition_TargetparamsA set of parameters to look up.string
GraphDefinition_Target_paramsExtensions for paramsElement
GraphDefinition_TargetprofileProfile for the target resource.canonical
GraphDefinition_TargetcompartmentCompartment Consistency Rules.GraphDefinition_Compartment
linkAdditional links from target resource.GraphDefinition_Link
GroupresourceTypeThis is a Group resourceGroup
GroupidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
GroupmetaThe metadata about the resource. 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
GroupimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
GrouplanguageThe base language in which the resource is written.code
Group_languageExtensions for languageElement
GrouptextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
GroupcontainedThese 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
GroupextensionMay be 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
GroupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
GroupidentifierA unique business identifier for this group.Identifier
GroupactiveIndicates whether the record for the group is available for use or is merely being retained for historical purposes.boolean
Group_activeExtensions for activeElement
GrouptypeIdentifies the broad classification of the kind of resources the group includes.enum values:
person
animal
practitioner
device
medication
substance
Group_typeExtensions for typeElement
GroupactualIf 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_actualExtensions for actualElement
GroupcodeProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc.CodeableConcept
GroupnameA label assigned to the group for human identification and communication.string
Group_nameExtensions for nameElement
GroupquantityA count of the number of resource instances that are part of the group.unsignedInt
Group_quantityExtensions for quantityElement
GroupmanagingEntityEntity responsible for defining and maintaining Group characteristics and/or registered members.Reference
GroupcharacteristicIdentifies traits whose presence r absence is shared by members of the group.Group_Characteristic
GroupmemberIdentifies the resource instances that are members of the group.Group_Member
Group_CharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Group_CharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CharacteristiccodeA code that identifies the kind of trait being asserted.CodeableConcept
Group_CharacteristicvalueCodeableConceptThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.CodeableConcept
Group_CharacteristicvalueBooleanThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.notDefined
Group_Characteristic_valueBooleanExtensions for valueBooleanElement
Group_CharacteristicvalueQuantityThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.Quantity
Group_CharacteristicvalueRangeThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.Range
Group_CharacteristicvalueReferenceThe value of the trait that holds (or does not hold - see 'exclude') for members of the group.Reference
Group_CharacteristicexcludeIf true, indicates the characteristic is one that is NOT held by members of the group.boolean
Group_Characteristic_excludeExtensions for excludeElement
Group_CharacteristicperiodThe period over which the characteristic is tested; e.g. the patient had an operation during the month of June.Period
Group_MemberidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Group_MemberextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MembermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MemberentityA 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_MemberperiodThe period that the member was in the group, if known.Period
Group_MemberinactiveA flag to indicate that the member is no longer in the group, but previously may have been a member.boolean
Group_Member_inactiveExtensions for inactiveElement
GuidanceResponseresourceTypeThis is a GuidanceResponse resourceGuidanceResponse
GuidanceResponseidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
GuidanceResponsemetaThe metadata about the resource. 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
GuidanceResponseimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
GuidanceResponselanguageThe base language in which the resource is written.code
GuidanceResponse_languageExtensions for languageElement
GuidanceResponsetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
GuidanceResponsecontainedThese 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
GuidanceResponseextensionMay be 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
GuidanceResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
GuidanceResponserequestIdentifierThe 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
GuidanceResponseidentifierAllows a service to provide unique, business identifiers for the response.Identifier
GuidanceResponsemoduleUriAn identifier, CodeableConcept or canonical reference to the guidance that was requested.notDefined
GuidanceResponse_moduleUriExtensions for moduleUriElement
GuidanceResponsemoduleCanonicalAn identifier, CodeableConcept or canonical reference to the guidance that was requested.notDefined
GuidanceResponse_moduleCanonicalExtensions for moduleCanonicalElement
GuidanceResponsemoduleCodeableConceptAn identifier, CodeableConcept or canonical reference to the guidance that was requested.CodeableConcept
GuidanceResponsestatusThe 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_statusExtensions for statusElement
GuidanceResponsesubjectThe patient for which the request was processed.Reference
GuidanceResponseencounterThe encounter during which this response was created or to which the creation of this record is tightly associated.Reference
GuidanceResponseoccurrenceDateTimeIndicates when the guidance response was processed.dateTime
GuidanceResponse_occurrenceDateTimeExtensions for occurrenceDateTimeElement
GuidanceResponseperformerProvides a reference to the device that performed the guidance.Reference
GuidanceResponsereasonDescribes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.CodeableReference
GuidanceResponsenoteProvides a mechanism to communicate additional information about the response.Annotation
GuidanceResponseevaluationMessageMessages 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
GuidanceResponseoutputParametersThe 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
GuidanceResponseresultThe actions, if any, produced by the evaluation of the artifact.Reference
GuidanceResponsedataRequirementIf 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
HealthcareServiceresourceTypeThis is a HealthcareService resourceHealthcareService
HealthcareServiceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
HealthcareServicemetaThe metadata about the resource. 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
HealthcareServiceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
HealthcareServicelanguageThe base language in which the resource is written.code
HealthcareService_languageExtensions for languageElement
HealthcareServicetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
HealthcareServicecontainedThese 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
HealthcareServiceextensionMay be 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
HealthcareServicemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
HealthcareServiceidentifierExternal identifiers for this item.Identifier
HealthcareServiceactiveThis 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_activeExtensions for activeElement
HealthcareServiceprovidedByThe organization that provides this healthcare service.Reference
HealthcareServicecategoryIdentifies the broad category of service being performed or delivered.CodeableConcept
HealthcareServicetypeThe specific type of service that may be delivered or performed.CodeableConcept
HealthcareServicespecialtyCollection of specialties handled by the service site. This is more of a medical term.CodeableConcept
HealthcareServicelocationThe location(s) where this healthcare service may be provided.Reference
HealthcareServicenameFurther description of the service as it would be presented to a consumer while searching.string
HealthcareService_nameExtensions for nameElement
HealthcareServicecommentAny 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_commentExtensions for commentElement
HealthcareServiceextraDetailsExtra details about the service that can't be placed in the other fields.markdown
HealthcareService_extraDetailsExtensions for extraDetailsElement
HealthcareServicephotoIf 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
HealthcareServicetelecomList of contacts related to this specific healthcare service.ContactPoint
HealthcareServicecoverageAreaThe location(s) that this service is available to (not where the service is provided).Reference
HealthcareServiceserviceProvisionCodeThe code(s) that detail the conditions under which the healthcare service is available/offered.CodeableConcept
HealthcareServiceeligibilityDoes this service have specific eligibility requirements that need to be met in order to use the service?HealthcareService_Eligibility
HealthcareServiceprogramPrograms that this service is applicable to.CodeableConcept
HealthcareServicecharacteristicCollection of characteristics (attributes).CodeableConcept
HealthcareServicecommunicationSome 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
HealthcareServicereferralMethodWays that the service accepts referrals, if this is not provided then it is implied that no referral is required.CodeableConcept
HealthcareServiceappointmentRequiredIndicates 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_appointmentRequiredExtensions for appointmentRequiredElement
HealthcareServiceavailableTimeA collection of times that the Service Site is available.HealthcareService_AvailableTime
HealthcareServicenotAvailableThe HealthcareService is not available during this period of time due to the provided reason.HealthcareService_NotAvailable
HealthcareServiceavailabilityExceptionsA 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_availabilityExceptionsExtensions for availabilityExceptionsElement
HealthcareServiceendpointTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource.Reference
HealthcareService_AvailableTimeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
HealthcareService_AvailableTimeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AvailableTimemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AvailableTimedaysOfWeekIndicates which days of the week are available between the start and end Times.enum values:
mon
tue
wed
thu
fri
sat
sun
HealthcareService_AvailableTime_daysOfWeekExtensions for daysOfWeekElement
HealthcareService_AvailableTimeallDayIs this always available? (hence times are irrelevant) e.g. 24 hour service.boolean
HealthcareService_AvailableTime_allDayExtensions for allDayElement
HealthcareService_AvailableTimeavailableStartTimeThe opening time of day. Note: If the AllDay flag is set, then this time is ignored.time
HealthcareService_AvailableTime_availableStartTimeExtensions for availableStartTimeElement
HealthcareService_AvailableTimeavailableEndTimeThe closing time of day. Note: If the AllDay flag is set, then this time is ignored.time
HealthcareService_AvailableTime_availableEndTimeExtensions for availableEndTimeElement
HealthcareService_EligibilityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
HealthcareService_EligibilityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EligibilitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EligibilitycodeCoded value for the eligibility.CodeableConcept
HealthcareService_EligibilitycommentDescribes the eligibility conditions for the service.markdown
HealthcareService_Eligibility_commentExtensions for commentElement
HealthcareService_NotAvailableidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
HealthcareService_NotAvailableextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_NotAvailablemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_NotAvailabledescriptionThe reason that can be presented to the user as to why this time is not available.string
HealthcareService_NotAvailable_descriptionExtensions for descriptionElement
HealthcareService_NotAvailableduringService is not available (seasonally or for a public holiday) from this date.Period
HumanNameidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
HumanNameextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
HumanNameuseIdentifies the purpose for this name.enum values:
usual
official
temp
nickname
anonymous
old
maiden
HumanName_useExtensions for useElement
HumanNametextSpecifies 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_textExtensions for textElement
HumanNamefamilyThe 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_familyExtensions for familyElement
HumanNamegivenGiven name.string
HumanName_givenExtensions for givenElement
HumanNameprefixPart 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_prefixExtensions for prefixElement
HumanNamesuffixPart 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_suffixExtensions for suffixElement
HumanNameperiodIndicates the period of time when this name was valid for the named person.Period
IdentifieridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
IdentifierextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
IdentifieruseThe purpose of this identifier.enum values:
usual
official
temp
secondary
old
Identifier_useExtensions for useElement
IdentifiertypeA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.CodeableConcept
IdentifiersystemEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.uri
Identifier_systemExtensions for systemElement
IdentifiervalueThe portion of the identifier typically relevant to the user and which is unique within the context of the system.string
Identifier_valueExtensions for valueElement
IdentifierperiodTime period during which identifier is/was valid for use.Period
IdentifierassignerOrganization that issued/manages the identifier.Reference
ImagingStudyresourceTypeThis is a ImagingStudy resourceImagingStudy
ImagingStudyidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ImagingStudymetaThe metadata about the resource. 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
ImagingStudyimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ImagingStudylanguageThe base language in which the resource is written.code
ImagingStudy_languageExtensions for languageElement
ImagingStudytextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ImagingStudycontainedThese 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
ImagingStudyextensionMay be 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
ImagingStudymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ImagingStudyidentifierIdentifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.Identifier
ImagingStudystatusThe current state of the ImagingStudy.enum values:
registered
available
cancelled
entered-in-error
unknown
ImagingStudy_statusExtensions for statusElement
ImagingStudymodalityA list of all the distinct values of series.modality. This may include both aquisition and non-aquisition modalities.Coding
ImagingStudysubjectThe subject, typically a patient, of the imaging study.Reference
ImagingStudyencounterThe healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.Reference
ImagingStudystartedDate and time the study started.dateTime
ImagingStudy_startedExtensions for startedElement
ImagingStudybasedOnA list of the diagnostic requests that resulted in this imaging study being performed.Reference
ImagingStudyreferrerThe requesting/referring physician.Reference
ImagingStudyinterpreterWho read the study and interpreted the images or other content.Reference
ImagingStudyendpointThe 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
ImagingStudynumberOfSeriesNumber 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_numberOfSeriesExtensions for numberOfSeriesElement
ImagingStudynumberOfInstancesNumber 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_numberOfInstancesExtensions for numberOfInstancesElement
ImagingStudyprocedureThe procedure or code from which this ImagingStudy was part of.ImagingStudy_Procedure
ImagingStudylocationThe principal physical location where the ImagingStudy was performed.Reference
ImagingStudyreasonDescription of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.CodeableReference
ImagingStudynotePer 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
ImagingStudydescriptionThe Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.string
ImagingStudy_descriptionExtensions for descriptionElement
ImagingStudyseriesEach study has one or more series of images or other content.ImagingStudy_Series
ImagingStudy_InstanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImagingStudy_InstanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InstanceuidThe DICOM SOP Instance UID for this image or other DICOM content.id
ImagingStudy_Instance_uidExtensions for uidElement
ImagingStudy_InstancesopClassDICOM instance type.Coding
ImagingStudy_InstancenumberThe number of instance in the series.unsignedInt
ImagingStudy_Instance_numberExtensions for numberElement
ImagingStudy_InstancetitleThe description of the instance.string
ImagingStudy_Instance_titleExtensions for titleElement
ImagingStudy_PerformeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImagingStudy_PerformerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PerformermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PerformerfunctionDistinguishes the type of involvement of the performer in the series.CodeableConcept
ImagingStudy_PerformeractorIndicates who or what performed the series.Reference
ImagingStudy_ProcedureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImagingStudy_ProcedureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProceduremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcedurevalueReferenceThe procedure which this ImagingStudy was part of.Reference
ImagingStudy_ProcedurevalueCodeableConceptThe procedure which this ImagingStudy was part of.CodeableConcept
ImagingStudy_SeriesidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImagingStudy_SeriesextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SeriesmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SeriesuidThe DICOM Series Instance UID for the series.id
ImagingStudy_Series_uidExtensions for uidElement
ImagingStudy_SeriesnumberThe numeric identifier of this series in the study.unsignedInt
ImagingStudy_Series_numberExtensions for numberElement
ImagingStudy_SeriesmodalityThe distinct modality for this series. This may include both aquisition and non-aquisition modalities.Coding
ImagingStudy_SeriesdescriptionA description of the series.string
ImagingStudy_Series_descriptionExtensions for descriptionElement
ImagingStudy_SeriesnumberOfInstancesNumber 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_numberOfInstancesExtensions for numberOfInstancesElement
ImagingStudy_SeriesendpointThe 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_SeriesbodySiteThe 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_SerieslateralityThe 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_SeriesspecimenThe specimen imaged, e.g., for whole slide imaging of a biopsy.Reference
ImagingStudy_SeriesstartedThe date and time the series was started.dateTime
ImagingStudy_Series_startedExtensions for startedElement
ImagingStudy_SeriesperformerIndicates who or what performed the series and how they were involved.ImagingStudy_Performer
ImagingStudy_SeriesinstanceA single SOP instance within the series, e.g. an image, or presentation state.ImagingStudy_Instance
ImmunizationresourceTypeThis is a Immunization resourceImmunization
ImmunizationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ImmunizationmetaThe metadata about the resource. 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
ImmunizationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ImmunizationlanguageThe base language in which the resource is written.code
Immunization_languageExtensions for languageElement
ImmunizationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ImmunizationcontainedThese 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
ImmunizationextensionMay be 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
ImmunizationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ImmunizationidentifierA unique identifier assigned to this immunization record.Identifier
ImmunizationstatusIndicates the current status of the immunization event.code
Immunization_statusExtensions for statusElement
ImmunizationstatusReasonIndicates the reason the immunization event was not performed.CodeableConcept
ImmunizationvaccineCodeVaccine that was administered or was to be administered.CodeableConcept
ImmunizationpatientThe patient who either received or did not receive the immunization.Reference
ImmunizationencounterThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.Reference
ImmunizationoccurrenceDateTimeDate vaccine administered or was to be administered.notDefined
Immunization_occurrenceDateTimeExtensions for occurrenceDateTimeElement
ImmunizationoccurrenceStringDate vaccine administered or was to be administered.notDefined
Immunization_occurrenceStringExtensions for occurrenceStringElement
ImmunizationrecordedThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.dateTime
Immunization_recordedExtensions for recordedElement
ImmunizationprimarySourceIndicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record.boolean
Immunization_primarySourceExtensions for primarySourceElement
ImmunizationinformationSourceCodeableConceptTypically 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
ImmunizationinformationSourceReferenceTypically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.Reference
ImmunizationlocationThe service delivery location where the vaccine administration occurred.Reference
ImmunizationmanufacturerName of vaccine manufacturer.Reference
ImmunizationlotNumberLot number of the vaccine product.string
Immunization_lotNumberExtensions for lotNumberElement
ImmunizationexpirationDateDate vaccine batch expires.date
Immunization_expirationDateExtensions for expirationDateElement
ImmunizationsiteBody site where vaccine was administered.CodeableConcept
ImmunizationrouteThe path by which the vaccine product is taken into the body.CodeableConcept
ImmunizationdoseQuantityThe quantity of vaccine product that was administered.Quantity
ImmunizationperformerIndicates who performed the immunization event.Immunization_Performer
ImmunizationnoteExtra information about the immunization that is not conveyed by the other attributes.Annotation
ImmunizationreasonDescribes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.CodeableReference
ImmunizationisSubpotentIndication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.boolean
Immunization_isSubpotentExtensions for isSubpotentElement
ImmunizationsubpotentReasonReason why a dose is considered to be subpotent.CodeableConcept
ImmunizationeducationEducational material presented to the patient (or guardian) at the time of vaccine administration.Immunization_Education
ImmunizationprogramEligibilityIndicates a patient's eligibility for a funding program.CodeableConcept
ImmunizationfundingSourceIndicates 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
ImmunizationreactionCategorical data indicating that an adverse event is associated in time to an immunization.Immunization_Reaction
ImmunizationprotocolAppliedThe protocol (set of recommendations) being followed by the provider who administered the dose.Immunization_ProtocolApplied
ImmunizationEvaluationresourceTypeThis is a ImmunizationEvaluation resourceImmunizationEvaluation
ImmunizationEvaluationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ImmunizationEvaluationmetaThe metadata about the resource. 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
ImmunizationEvaluationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ImmunizationEvaluationlanguageThe base language in which the resource is written.code
ImmunizationEvaluation_languageExtensions for languageElement
ImmunizationEvaluationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ImmunizationEvaluationcontainedThese 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
ImmunizationEvaluationextensionMay be 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
ImmunizationEvaluationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ImmunizationEvaluationidentifierA unique identifier assigned to this immunization evaluation record.Identifier
ImmunizationEvaluationstatusIndicates the current status of the evaluation of the vaccination administration event.code
ImmunizationEvaluation_statusExtensions for statusElement
ImmunizationEvaluationpatientThe individual for whom the evaluation is being done.Reference
ImmunizationEvaluationdateThe date the evaluation of the vaccine administration event was performed.dateTime
ImmunizationEvaluation_dateExtensions for dateElement
ImmunizationEvaluationauthorityIndicates the authority who published the protocol (e.g. ACIP).Reference
ImmunizationEvaluationtargetDiseaseThe vaccine preventable disease the dose is being evaluated against.CodeableConcept
ImmunizationEvaluationimmunizationEventThe vaccine administration event being evaluated.Reference
ImmunizationEvaluationdoseStatusIndicates if the dose is valid or not valid with respect to the published recommendations.CodeableConcept
ImmunizationEvaluationdoseStatusReasonProvides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.CodeableConcept
ImmunizationEvaluationdescriptionAdditional information about the evaluation.string
ImmunizationEvaluation_descriptionExtensions for descriptionElement
ImmunizationEvaluationseriesOne possible path to achieve presumed immunity against a disease - within the context of an authority.string
ImmunizationEvaluation_seriesExtensions for seriesElement
ImmunizationEvaluationdoseNumberNominal position in a series as determined by the outcome of the evaluation process.string
ImmunizationEvaluation_doseNumberExtensions for doseNumberElement
ImmunizationEvaluationseriesDosesThe recommended number of doses to achieve immunity as determined by the outcome of the evaluation process.string
ImmunizationEvaluation_seriesDosesExtensions for seriesDosesElement
ImmunizationRecommendationresourceTypeThis is a ImmunizationRecommendation resourceImmunizationRecommendation
ImmunizationRecommendationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ImmunizationRecommendationmetaThe metadata about the resource. 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
ImmunizationRecommendationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ImmunizationRecommendationlanguageThe base language in which the resource is written.code
ImmunizationRecommendation_languageExtensions for languageElement
ImmunizationRecommendationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ImmunizationRecommendationcontainedThese 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
ImmunizationRecommendationextensionMay be 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
ImmunizationRecommendationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ImmunizationRecommendationidentifierA unique identifier assigned to this particular recommendation record.Identifier
ImmunizationRecommendationpatientThe patient the recommendation(s) are for.Reference
ImmunizationRecommendationdateThe date the immunization recommendation(s) were created.dateTime
ImmunizationRecommendation_dateExtensions for dateElement
ImmunizationRecommendationauthorityIndicates the authority who published the protocol (e.g. ACIP).Reference
ImmunizationRecommendationrecommendationVaccine administration recommendations.ImmunizationRecommendation_Recommendation
ImmunizationRecommendation_DateCriterionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImmunizationRecommendation_DateCriterionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DateCriterionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DateCriterioncodeDate classification of recommendation. For example, earliest date to give, latest date to give, etc.CodeableConcept
ImmunizationRecommendation_DateCriterionvalueThe date whose meaning is specified by dateCriterion.code.dateTime
ImmunizationRecommendation_DateCriterion_valueExtensions for valueElement
ImmunizationRecommendation_RecommendationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImmunizationRecommendation_RecommendationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RecommendationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RecommendationvaccineCodeVaccine(s) or vaccine group that pertain to the recommendation.CodeableConcept
ImmunizationRecommendation_RecommendationtargetDiseaseThe targeted disease for the recommendation.CodeableConcept
ImmunizationRecommendation_RecommendationcontraindicatedVaccineCodeVaccine(s) which should not be used to fulfill the recommendation.CodeableConcept
ImmunizationRecommendation_RecommendationforecastStatusIndicates the patient status with respect to the path to immunity for the target disease.CodeableConcept
ImmunizationRecommendation_RecommendationforecastReasonThe reason for the assigned forecast status.CodeableConcept
ImmunizationRecommendation_RecommendationdateCriterionVaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.ImmunizationRecommendation_DateCriterion
ImmunizationRecommendation_RecommendationdescriptionContains the description about the protocol under which the vaccine was administered.string
ImmunizationRecommendation_Recommendation_descriptionExtensions for descriptionElement
ImmunizationRecommendation_RecommendationseriesOne possible path to achieve presumed immunity against a disease - within the context of an authority.string
ImmunizationRecommendation_Recommendation_seriesExtensions for seriesElement
ImmunizationRecommendation_RecommendationdoseNumberNominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).string
ImmunizationRecommendation_Recommendation_doseNumberExtensions for doseNumberElement
ImmunizationRecommendation_RecommendationseriesDosesThe recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.string
ImmunizationRecommendation_Recommendation_seriesDosesExtensions for seriesDosesElement
ImmunizationRecommendation_RecommendationsupportingImmunizationImmunization event history and/or evaluation that supports the status and recommendation.Reference
ImmunizationRecommendation_RecommendationsupportingPatientInformationPatient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.Reference
Immunization_EducationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Immunization_EducationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EducationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EducationdocumentTypeIdentifier of the material presented to the patient.string
Immunization_Education_documentTypeExtensions for documentTypeElement
Immunization_EducationreferenceReference pointer to the educational material given to the patient if the information was on line.uri
Immunization_Education_referenceExtensions for referenceElement
Immunization_EducationpublicationDateDate the educational material was published.dateTime
Immunization_Education_publicationDateExtensions for publicationDateElement
Immunization_EducationpresentationDateDate the educational material was given to the patient.dateTime
Immunization_Education_presentationDateExtensions for presentationDateElement
Immunization_PerformeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Immunization_PerformerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PerformermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PerformerfunctionDescribes the type of performance (e.g. ordering provider, administering provider, etc.).CodeableConcept
Immunization_PerformeractorThe practitioner or organization who performed the action.Reference
Immunization_ProtocolAppliedidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Immunization_ProtocolAppliedextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProtocolAppliedmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProtocolAppliedseriesOne possible path to achieve presumed immunity against a disease - within the context of an authority.string
Immunization_ProtocolApplied_seriesExtensions for seriesElement
Immunization_ProtocolAppliedauthorityIndicates the authority who published the protocol (e.g. ACIP) that is being followed.Reference
Immunization_ProtocolAppliedtargetDiseaseThe vaccine preventable disease the dose is being administered against.CodeableConcept
Immunization_ProtocolApplieddoseNumberNominal position in a series as intended by the practitioner administering the dose.string
Immunization_ProtocolApplied_doseNumberExtensions for doseNumberElement
Immunization_ProtocolAppliedseriesDosesThe recommended number of doses to achieve immunity as intended by the practitioner administering the dose.string
Immunization_ProtocolApplied_seriesDosesExtensions for seriesDosesElement
Immunization_ReactionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Immunization_ReactionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ReactionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ReactiondateDate of reaction to the immunization.dateTime
Immunization_Reaction_dateExtensions for dateElement
Immunization_ReactiondetailDetails of the reaction.Reference
Immunization_ReactionreportedSelf-reported indicator.boolean
Immunization_Reaction_reportedExtensions for reportedElement
ImplementationGuideresourceTypeThis is a ImplementationGuide resourceImplementationGuide
ImplementationGuideidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ImplementationGuidemetaThe metadata about the resource. 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
ImplementationGuideimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ImplementationGuidelanguageThe base language in which the resource is written.code
ImplementationGuide_languageExtensions for languageElement
ImplementationGuidetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ImplementationGuidecontainedThese 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
ImplementationGuideextensionMay be 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
ImplementationGuidemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ImplementationGuideurlAn 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_urlExtensions for urlElement
ImplementationGuideidentifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
ImplementationGuideversionThe 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_versionExtensions for versionElement
ImplementationGuidenameA 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_nameExtensions for nameElement
ImplementationGuidetitleA short, descriptive, user-friendly title for the implementation guide.string
ImplementationGuide_titleExtensions for titleElement
ImplementationGuidestatusThe status of this implementation guide. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
ImplementationGuide_statusExtensions for statusElement
ImplementationGuideexperimentalA 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_experimentalExtensions for experimentalElement
ImplementationGuidedateThe 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_dateExtensions for dateElement
ImplementationGuidepublisherThe name of the organization or individual that published the implementation guide.string
ImplementationGuide_publisherExtensions for publisherElement
ImplementationGuidecontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ImplementationGuidedescriptionA free text natural language description of the implementation guide from a consumer's perspective.markdown
ImplementationGuide_descriptionExtensions for descriptionElement
ImplementationGuideuseContextThe 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
ImplementationGuidejurisdictionA legal or geographic region in which the implementation guide is intended to be used.CodeableConcept
ImplementationGuidepurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
ImplementationGuide_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
ImplementationGuidepackageIdThe 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_packageIdExtensions for packageIdElement
ImplementationGuidelicenseThe 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_licenseExtensions for licenseElement
ImplementationGuidefhirVersionThe 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.4.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.0.2
3.3.0
3.5.0
4.0.0
4.0.1
4.1.0
4.2.0
4.4.0
ImplementationGuide_fhirVersionExtensions for fhirVersionElement
ImplementationGuidedependsOnAnother implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.ImplementationGuide_DependsOn
ImplementationGuideglobalA set of profiles that all resources covered by this implementation guide must conform to.ImplementationGuide_Global
ImplementationGuidedefinitionThe information needed by an IG publisher tool to publish the whole implementation guide.ImplementationGuide_Definition
ImplementationGuidemanifestInformation about an assembled implementation guide, created by the publication tooling.ImplementationGuide_Manifest
ImplementationGuide_DefinitionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_DefinitionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DefinitiongroupingA logical group of resources. Logical groups can be used when building pages.ImplementationGuide_Grouping
ImplementationGuide_DefinitionresourceA 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_DefinitionpageA page / section in the implementation guide. The root page is the implementation guide home page.ImplementationGuide_Page
ImplementationGuide_DefinitionparameterA set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides.ImplementationGuide_Parameter
ImplementationGuide_DefinitiontemplateA template for building resources.ImplementationGuide_Template
ImplementationGuide_DependsOnidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_DependsOnextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DependsOnmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DependsOnuriA canonical reference to the Implementation guide for the dependency.canonical
ImplementationGuide_DependsOnpackageIdThe NPM package name for the Implementation Guide that this IG depends on.id
ImplementationGuide_DependsOn_packageIdExtensions for packageIdElement
ImplementationGuide_DependsOnversionThe version of the IG that is depended on, when the correct version is required to understand the IG correctly.string
ImplementationGuide_DependsOn_versionExtensions for versionElement
ImplementationGuide_GlobalidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_GlobalextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GlobalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GlobaltypeThe type of resource that all instances must conform to.code
ImplementationGuide_Global_typeExtensions for typeElement
ImplementationGuide_GlobalprofileA reference to the profile that all instances must conform to.canonical
ImplementationGuide_GroupingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_GroupingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GroupingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GroupingnameThe human-readable title to display for the package of resources when rendering the implementation guide.string
ImplementationGuide_Grouping_nameExtensions for nameElement
ImplementationGuide_GroupingdescriptionHuman readable text describing the package.string
ImplementationGuide_Grouping_descriptionExtensions for descriptionElement
ImplementationGuide_ManifestidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_ManifestextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ManifestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ManifestrenderingA pointer to official web page, PDF or other rendering of the implementation guide.url
ImplementationGuide_Manifest_renderingExtensions for renderingElement
ImplementationGuide_ManifestresourceA 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_ManifestpageInformation about a page within the IG.ImplementationGuide_Page1
ImplementationGuide_ManifestimageIndicates a relative path to an image that exists within the IG.string
ImplementationGuide_Manifest_imageExtensions for imageElement
ImplementationGuide_ManifestotherIndicates 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_otherExtensions for otherElement
ImplementationGuide_PageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_PageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PagenameUrlThe source address for the page.notDefined
ImplementationGuide_Page_nameUrlExtensions for nameUrlElement
ImplementationGuide_PagenameReferenceThe source address for the page.Reference
ImplementationGuide_PagetitleA short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.string
ImplementationGuide_Page_titleExtensions for titleElement
ImplementationGuide_PagegenerationA code that indicates how the page is generated.enum values:
html
markdown
xml
generated
ImplementationGuide_Page_generationExtensions for generationElement
ImplementationGuide_PagepageNested Pages/Sections under this page.ImplementationGuide_Page
ImplementationGuide_Page1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_Page1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Page1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Page1nameRelative path to the page.string
ImplementationGuide_Page1_nameExtensions for nameElement
ImplementationGuide_Page1titleLabel for the page intended for human display.string
ImplementationGuide_Page1_titleExtensions for titleElement
ImplementationGuide_Page1anchorThe name of an anchor available on the page.string
ImplementationGuide_Page1_anchorExtensions for anchorElement
ImplementationGuide_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParametercodeCode that identifies parameter.string
ImplementationGuide_Parameter_codeExtensions for codeElement
ImplementationGuide_ParametervalueValue for named type.string
ImplementationGuide_Parameter_valueExtensions for valueElement
ImplementationGuide_ResourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_ResourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ResourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ResourcereferenceWhere this resource is found.Reference
ImplementationGuide_ResourcefhirVersionIndicates 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.0.2
3.3.0
3.5.0
4.0.0
4.0.1
4.1.0
4.2.0
4.4.0
ImplementationGuide_Resource_fhirVersionExtensions for fhirVersionElement
ImplementationGuide_ResourcenameA 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_nameExtensions for nameElement
ImplementationGuide_ResourcedescriptionA description of the reason that a resource has been included in the implementation guide.string
ImplementationGuide_Resource_descriptionExtensions for descriptionElement
ImplementationGuide_ResourceexampleBooleanIf 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_exampleBooleanExtensions for exampleBooleanElement
ImplementationGuide_ResourceexampleCanonicalIf 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_exampleCanonicalExtensions for exampleCanonicalElement
ImplementationGuide_ResourcegroupingIdReference to the id of the grouping this resource appears in.id
ImplementationGuide_Resource_groupingIdExtensions for groupingIdElement
ImplementationGuide_Resource1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_Resource1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Resource1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Resource1referenceWhere this resource is found.Reference
ImplementationGuide_Resource1exampleBooleanIf 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_exampleBooleanExtensions for exampleBooleanElement
ImplementationGuide_Resource1exampleCanonicalIf 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_exampleCanonicalExtensions for exampleCanonicalElement
ImplementationGuide_Resource1relativePathThe relative path for primary page for this resource within the IG.url
ImplementationGuide_Resource1_relativePathExtensions for relativePathElement
ImplementationGuide_TemplateidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ImplementationGuide_TemplateextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TemplatemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TemplatecodeType of template specified.code
ImplementationGuide_Template_codeExtensions for codeElement
ImplementationGuide_TemplatesourceThe source location for the template.string
ImplementationGuide_Template_sourceExtensions for sourceElement
ImplementationGuide_TemplatescopeThe scope in which the template applies.string
ImplementationGuide_Template_scopeExtensions for scopeElement
IngredientresourceTypeThis is a Ingredient resourceIngredient
IngredientidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
IngredientmetaThe metadata about the resource. 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
IngredientimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
Ingredient_implicitRulesExtensions for implicitRulesElement
IngredientlanguageThe base language in which the resource is written.code
Ingredient_languageExtensions for languageElement
IngredienttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
IngredientcontainedThese 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
IngredientextensionMay be 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
IngredientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
IngredientidentifierThe 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
IngredientroleIngredient role within a drug product e.g. Active ingredient, Excipient.CodeableConcept
IngredientfunctionA classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent.CodeableConcept
IngredientdescriptionA general description of the ingredient, or any supporting text. May be used for an unstructured list of excipients.markdown
Ingredient_descriptionExtensions for descriptionElement
IngredientallergenicIndicatorIf the ingredient is a known or suspected allergen.boolean
Ingredient_allergenicIndicatorExtensions for allergenicIndicatorElement
IngredientmanufacturerThe organization that manufactures this ingredient.Reference
IngredientspecifiedSubstanceA specified substance that comprises this ingredient.Ingredient_SpecifiedSubstance
IngredientsubstanceThe substance that comprises this ingredient.Ingredient_Substance
Ingredient_ReferenceStrengthidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Ingredient_ReferenceStrengthextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Ingredient_ReferenceStrengthmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Ingredient_ReferenceStrengthsubstanceCodeableConceptRelevant reference substance.CodeableConcept
Ingredient_ReferenceStrengthsubstanceReferenceRelevant reference substance.Reference
Ingredient_ReferenceStrengthstrengthStrength expressed in terms of a reference substance.Ratio
Ingredient_ReferenceStrengthstrengthHighLimitStrength expressed in terms of a reference substance, upper limit.Ratio
Ingredient_ReferenceStrengthmeasurementPointFor when strength is measured at a particular point or distance.string
Ingredient_ReferenceStrength_measurementPointExtensions for measurementPointElement
Ingredient_ReferenceStrengthcountryThe country or countries for which the strength range applies.CodeableConcept
Ingredient_SpecifiedSubstanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Ingredient_SpecifiedSubstanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Ingredient_SpecifiedSubstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Ingredient_SpecifiedSubstancecodeCodeableConceptSubstance as a 'specified substance', implying extra substance related characteristics.CodeableConcept
Ingredient_SpecifiedSubstancecodeReferenceSubstance as a 'specified substance', implying extra substance related characteristics.Reference
Ingredient_SpecifiedSubstancegroupThe group of specified substance, e.g. group 1 to 4.CodeableConcept
Ingredient_SpecifiedSubstanceconfidentialityConfidentiality level of the specified substance as the ingredient.CodeableConcept
Ingredient_SpecifiedSubstancestrengthQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product.Ingredient_Strength
Ingredient_StrengthidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Ingredient_StrengthextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Ingredient_StrengthmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Ingredient_StrengthpresentationThe quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.Ratio
Ingredient_StrengthpresentationHighLimitAn upper limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the high limit, with the presentation attribute becoming the lower limit.Ratio
Ingredient_StrengthpresentationTextA textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.string
Ingredient_Strength_presentationTextExtensions for presentationTextElement
Ingredient_StrengthconcentrationThe strength per unitary volume (or mass).Ratio
Ingredient_StrengthconcentrationHighLimitAn upper limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the lower limit.Ratio
Ingredient_StrengthconcentrationTextA textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.string
Ingredient_Strength_concentrationTextExtensions for concentrationTextElement
Ingredient_StrengthmeasurementPointFor when strength is measured at a particular point or distance.string
Ingredient_Strength_measurementPointExtensions for measurementPointElement
Ingredient_StrengthcountryThe country or countries for which the strength range applies.CodeableConcept
Ingredient_StrengthreferenceStrengthStrength expressed in terms of a reference substance.Ingredient_ReferenceStrength
Ingredient_SubstanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Ingredient_SubstanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Ingredient_SubstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Ingredient_SubstancecodeCodeableConceptA code that represents the ingredient substance.CodeableConcept
Ingredient_SubstancecodeReferenceA code that represents the ingredient substance.Reference
Ingredient_SubstancestrengthQuantity of the substance or specified substance present in the manufactured item or pharmaceutical product.Ingredient_Strength
InsurancePlanresourceTypeThis is a InsurancePlan resourceInsurancePlan
InsurancePlanidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
InsurancePlanmetaThe metadata about the resource. 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
InsurancePlanimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
InsurancePlanlanguageThe base language in which the resource is written.code
InsurancePlan_languageExtensions for languageElement
InsurancePlantextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
InsurancePlancontainedThese 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
InsurancePlanextensionMay be 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
InsurancePlanmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
InsurancePlanidentifierBusiness identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.Identifier
InsurancePlanstatusThe current state of the health insurance product.enum values:
draft
active
retired
unknown
InsurancePlan_statusExtensions for statusElement
InsurancePlantypeThe kind of health insurance product.CodeableConcept
InsurancePlannameOfficial name of the health insurance product as designated by the owner.string
InsurancePlan_nameExtensions for nameElement
InsurancePlanaliasA list of alternate names that the product is known as, or was known as in the past.string
InsurancePlan_aliasExtensions for aliasElement
InsurancePlanperiodThe period of time that the health insurance product is available.Period
InsurancePlanownedByThe 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
InsurancePlanadministeredByAn organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.Reference
InsurancePlancoverageAreaThe geographic region in which a health insurance product's benefits apply.Reference
InsurancePlancontactThe contact for the health insurance product for a certain purpose.InsurancePlan_Contact
InsurancePlanendpointThe technical endpoints providing access to services operated for the health insurance product.Reference
InsurancePlannetworkReference to the network included in the health insurance product.Reference
InsurancePlancoverageDetails about the coverage offered by the insurance product.InsurancePlan_Coverage
InsurancePlanplanDetails about an insurance plan.InsurancePlan_Plan
InsurancePlan_BenefitidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_BenefitextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_BenefitmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_BenefittypeType of benefit (primary care; speciality care; inpatient; outpatient).CodeableConcept
InsurancePlan_BenefitrequirementThe referral requirements to have access/coverage for this benefit.string
InsurancePlan_Benefit_requirementExtensions for requirementElement
InsurancePlan_BenefitlimitThe specific limits on the benefit.InsurancePlan_Limit
InsurancePlan_Benefit1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_Benefit1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Benefit1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Benefit1typeType of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care).CodeableConcept
InsurancePlan_Benefit1costList of the costs associated with a specific benefit.InsurancePlan_Cost
InsurancePlan_ContactidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_ContactextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContactmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContactpurposeIndicates a purpose for which the contact can be reached.CodeableConcept
InsurancePlan_ContactnameA name associated with the contact.HumanName
InsurancePlan_ContacttelecomA contact detail (e.g. a telephone number or an email address) by which the party may be contacted.ContactPoint
InsurancePlan_ContactaddressVisiting or postal addresses for the contact.Address
InsurancePlan_CostidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_CostextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CostmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CosttypeType of cost (copay; individual cap; family cap; coinsurance; deductible).CodeableConcept
InsurancePlan_CostapplicabilityWhether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other).CodeableConcept
InsurancePlan_CostqualifiersAdditional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).CodeableConcept
InsurancePlan_CostvalueThe actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).Quantity
InsurancePlan_CoverageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_CoverageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CoveragemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CoveragetypeType of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).CodeableConcept
InsurancePlan_CoveragenetworkReference to the network that providing the type of coverage.Reference
InsurancePlan_CoveragebenefitSpecific benefits under this type of coverage.InsurancePlan_Benefit
InsurancePlan_GeneralCostidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_GeneralCostextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GeneralCostmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GeneralCosttypeType of cost.CodeableConcept
InsurancePlan_GeneralCostgroupSizeNumber of participants enrolled in the plan.positiveInt
InsurancePlan_GeneralCost_groupSizeExtensions for groupSizeElement
InsurancePlan_GeneralCostcostValue of the cost.Money
InsurancePlan_GeneralCostcommentAdditional information about the general costs associated with this plan.string
InsurancePlan_GeneralCost_commentExtensions for commentElement
InsurancePlan_LimitidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_LimitextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_LimitmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_LimitvalueThe maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.Quantity
InsurancePlan_LimitcodeThe specific limit on the benefit.CodeableConcept
InsurancePlan_PlanidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_PlanextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PlanmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PlanidentifierBusiness identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.Identifier
InsurancePlan_PlantypeType of plan. For example, "Platinum" or "High Deductable".CodeableConcept
InsurancePlan_PlancoverageAreaThe geographic region in which a health insurance plan's benefits apply.Reference
InsurancePlan_PlannetworkReference to the network that providing the type of coverage.Reference
InsurancePlan_PlangeneralCostOverall costs associated with the plan.InsurancePlan_GeneralCost
InsurancePlan_PlanspecificCostCosts associated with the coverage provided by the product.InsurancePlan_SpecificCost
InsurancePlan_SpecificCostidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
InsurancePlan_SpecificCostextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SpecificCostmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SpecificCostcategoryGeneral category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).CodeableConcept
InsurancePlan_SpecificCostbenefitList of the specific benefits under this category of benefit.InsurancePlan_Benefit1
InvoiceresourceTypeThis is a Invoice resourceInvoice
InvoiceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
InvoicemetaThe metadata about the resource. 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
InvoiceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
InvoicelanguageThe base language in which the resource is written.code
Invoice_languageExtensions for languageElement
InvoicetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
InvoicecontainedThese 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
InvoiceextensionMay be 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
InvoicemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
InvoiceidentifierIdentifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.Identifier
InvoicestatusThe current state of the Invoice.enum values:
draft
issued
balanced
cancelled
entered-in-error
Invoice_statusExtensions for statusElement
InvoicecancelledReasonIn case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).string
Invoice_cancelledReasonExtensions for cancelledReasonElement
InvoicetypeType of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).CodeableConcept
InvoicesubjectThe individual or set of individuals receiving the goods and services billed in this invoice.Reference
InvoicerecipientThe individual or Organization responsible for balancing of this invoice.Reference
InvoicedateDate/time(s) of when this Invoice was posted.dateTime
Invoice_dateExtensions for dateElement
InvoiceparticipantIndicates who or what performed or participated in the charged service.Invoice_Participant
InvoiceissuerThe organizationissuing the Invoice.Reference
InvoiceaccountAccount which is supposed to be balanced with this Invoice.Reference
InvoicelineItemEach 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
InvoicetotalPriceComponentThe 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
InvoicetotalNetInvoice total , taxes excluded.Money
InvoicetotalGrossInvoice total, tax included.Money
InvoicepaymentTermsPayment details such as banking details, period of payment, deductibles, methods of payment.markdown
Invoice_paymentTermsExtensions for paymentTermsElement
InvoicenoteComments made about the invoice by the issuer, subject, or other participants.Annotation
Invoice_LineItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Invoice_LineItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_LineItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_LineItemsequenceSequence in which the items appear on the invoice.positiveInt
Invoice_LineItem_sequenceExtensions for sequenceElement
Invoice_LineItemchargeItemReferenceThe 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_LineItemchargeItemCodeableConceptThe 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_LineItempriceComponentThe 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_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Invoice_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipantroleDescribes 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_ParticipantactorThe device, practitioner, etc. who performed or participated in the service.Reference
Invoice_PriceComponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Invoice_PriceComponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PriceComponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PriceComponenttypeThis code identifies the type of the component.enum values:
base
surcharge
deduction
discount
tax
informational
Invoice_PriceComponent_typeExtensions for typeElement
Invoice_PriceComponentcodeA code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.CodeableConcept
Invoice_PriceComponentfactorThe factor that has been applied on the base price for calculating this component.decimal
Invoice_PriceComponent_factorExtensions for factorElement
Invoice_PriceComponentamountThe amount calculated for this component.Money
LibraryresourceTypeThis is a Library resourceLibrary
LibraryidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
LibrarymetaThe metadata about the resource. 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
LibraryimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
LibrarylanguageThe base language in which the resource is written.code
Library_languageExtensions for languageElement
LibrarytextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
LibrarycontainedThese 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
LibraryextensionMay be 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
LibrarymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
LibraryurlAn 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_urlExtensions for urlElement
LibraryidentifierA 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
LibraryversionThe 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_versionExtensions for versionElement
LibrarynameA 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_nameExtensions for nameElement
LibrarytitleA short, descriptive, user-friendly title for the library.string
Library_titleExtensions for titleElement
LibrarystatusThe status of this library. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
Library_statusExtensions for statusElement
LibraryexperimentalA 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_experimentalExtensions for experimentalElement
LibrarydateThe 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_dateExtensions for dateElement
LibrarypublisherThe name of the organization or individual that published the library.string
Library_publisherExtensions for publisherElement
LibrarycontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
LibrarydescriptionA free text natural language description of the library from a consumer's perspective.markdown
Library_descriptionExtensions for descriptionElement
LibraryuseContextThe 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
LibraryjurisdictionA legal or geographic region in which the library is intended to be used.CodeableConcept
LibrarypurposeExplanation of why this library is needed and why it has been designed as it has.markdown
Library_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
LibraryapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
Library_approvalDateExtensions for approvalDateElement
LibrarylastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
Library_lastReviewDateExtensions for lastReviewDateElement
LibraryeffectivePeriodThe period during which the library content was or is planned to be in active use.Period
LibrarysubtitleAn explanatory or alternate title for the library giving additional information about its content.string
Library_subtitleExtensions for subtitleElement
LibrarytypeIdentifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.CodeableConcept
LibrarysubjectCodeableConceptA code or group definition that describes the intended subject of the contents of the library.CodeableConcept
LibrarysubjectReferenceA code or group definition that describes the intended subject of the contents of the library.Reference
LibraryusageA detailed description of how the library is used from a clinical perspective.string
Library_usageExtensions for usageElement
LibrarytopicDescriptive 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
LibraryauthorAn individiual or organization primarily involved in the creation and maintenance of the content.ContactDetail
LibraryeditorAn individual or organization primarily responsible for internal coherence of the content.ContactDetail
LibraryreviewerAn individual or organization primarily responsible for review of some aspect of the content.ContactDetail
LibraryendorserAn individual or organization responsible for officially endorsing the content for use in some setting.ContactDetail
LibraryrelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.RelatedArtifact
LibraryparameterThe parameter element defines parameters used by the library.ParameterDefinition
LibrarydataRequirementDescribes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.DataRequirement
LibrarycontentThe 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
LinkageresourceTypeThis is a Linkage resourceLinkage
LinkageidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
LinkagemetaThe metadata about the resource. 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
LinkageimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
LinkagelanguageThe base language in which the resource is written.code
Linkage_languageExtensions for languageElement
LinkagetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
LinkagecontainedThese 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
LinkageextensionMay be 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
LinkagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
LinkageactiveIndicates whether the asserted set of linkages are considered to be "in effect".boolean
Linkage_activeExtensions for activeElement
LinkageauthorIdentifies 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
LinkageitemIdentifies 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_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Linkage_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemtypeDistinguishes 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_typeExtensions for typeElement
Linkage_ItemresourceThe resource instance being linked as part of the group.Reference
ListresourceTypeThis is a List resourceList
ListidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ListmetaThe metadata about the resource. 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
ListimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ListlanguageThe base language in which the resource is written.code
List_languageExtensions for languageElement
ListtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ListcontainedThese 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
ListextensionMay be 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
ListmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ListidentifierIdentifier for the List assigned for business purposes outside the context of FHIR.Identifier
ListstatusIndicates the current state of this list.enum values:
current
retired
entered-in-error
List_statusExtensions for statusElement
ListmodeHow 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_modeExtensions for modeElement
ListtitleA label for the list assigned by the author.string
List_titleExtensions for titleElement
ListcodeThis code defines the purpose of the list - why it was created.CodeableConcept
ListsubjectThe common subject (or patient) of the resources that are in the list if there is one.Reference
ListencounterThe encounter that is the context in which this list was created.Reference
ListdateThe date that the list was prepared.dateTime
List_dateExtensions for dateElement
ListsourceThe 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
ListorderedByWhat order applies to the items in the list.CodeableConcept
ListnoteComments that apply to the overall list.Annotation
ListentryEntries in this list.List_Entry
ListemptyReasonIf the list is empty, why the list is empty.CodeableConcept
List_EntryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
List_EntryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EntrymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EntryflagThe flag allows the system constructing the list to indicate the role and significance of the item in the list.CodeableConcept
List_EntrydeletedTrue if this item is marked as deleted in the list.boolean
List_Entry_deletedExtensions for deletedElement
List_EntrydateWhen this item was added to the list.dateTime
List_Entry_dateExtensions for dateElement
List_EntryitemA reference to the actual resource from which data was derived.Reference
LocationresourceTypeThis is a Location resourceLocation
LocationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
LocationmetaThe metadata about the resource. 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
LocationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
LocationlanguageThe base language in which the resource is written.code
Location_languageExtensions for languageElement
LocationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
LocationcontainedThese 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
LocationextensionMay be 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
LocationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
LocationidentifierUnique code or number identifying the location to its users.Identifier
LocationstatusThe 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_statusExtensions for statusElement
LocationoperationalStatusThe 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
LocationnameName of the location as used by humans. Does not need to be unique.string
Location_nameExtensions for nameElement
LocationaliasA list of alternate names that the location is known as, or was known as, in the past.string
Location_aliasExtensions for aliasElement
LocationdescriptionDescription of the Location, which helps in finding or referencing the place.string
Location_descriptionExtensions for descriptionElement
LocationmodeIndicates whether a resource instance represents a specific location or a class of locations.enum values:
instance
kind
Location_modeExtensions for modeElement
LocationtypeIndicates the type of function performed at the location.CodeableConcept
LocationtelecomThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.ContactPoint
LocationaddressPhysical location.Address
LocationphysicalTypePhysical form of the location, e.g. building, room, vehicle, road.CodeableConcept
LocationpositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).Location_Position
LocationmanagingOrganizationThe organization responsible for the provisioning and upkeep of the location.Reference
LocationpartOfAnother Location of which this Location is physically a part of.Reference
LocationhoursOfOperationWhat days/times during a week is this location usually open.Location_HoursOfOperation
LocationavailabilityExceptionsA 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_availabilityExceptionsExtensions for availabilityExceptionsElement
LocationendpointTechnical endpoints providing access to services operated for the location.Reference
Location_HoursOfOperationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Location_HoursOfOperationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_HoursOfOperationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_HoursOfOperationdaysOfWeekIndicates which days of the week are available between the start and end Times.code
Location_HoursOfOperation_daysOfWeekExtensions for daysOfWeekElement
Location_HoursOfOperationallDayThe Location is open all day.boolean
Location_HoursOfOperation_allDayExtensions for allDayElement
Location_HoursOfOperationopeningTimeTime that the Location opens.time
Location_HoursOfOperation_openingTimeExtensions for openingTimeElement
Location_HoursOfOperationclosingTimeTime that the Location closes.time
Location_HoursOfOperation_closingTimeExtensions for closingTimeElement
Location_PositionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Location_PositionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PositionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PositionlongitudeLongitude. 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_longitudeExtensions for longitudeElement
Location_PositionlatitudeLatitude. 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_latitudeExtensions for latitudeElement
Location_PositionaltitudeAltitude. 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_altitudeExtensions for altitudeElement
ManufacturedItemDefinitionresourceTypeThis is a ManufacturedItemDefinition resourceManufacturedItemDefinition
ManufacturedItemDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ManufacturedItemDefinitionmetaThe metadata about the resource. 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
ManufacturedItemDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
ManufacturedItemDefinition_implicitRulesExtensions for implicitRulesElement
ManufacturedItemDefinitionlanguageThe base language in which the resource is written.code
ManufacturedItemDefinition_languageExtensions for languageElement
ManufacturedItemDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ManufacturedItemDefinitioncontainedThese 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
ManufacturedItemDefinitionextensionMay be 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
ManufacturedItemDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ManufacturedItemDefinitionidentifierUnique identifier.Identifier
ManufacturedItemDefinitionmanufacturedDoseFormDose form as manufactured and before any transformation into the pharmaceutical product.CodeableConcept
ManufacturedItemDefinitionunitOfPresentationThe “real world” units in which the quantity of the manufactured item is described.CodeableConcept
ManufacturedItemDefinitionmanufacturerManufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues).Reference
ManufacturedItemDefinitioningredientThe ingredients that make up this manufactured item.Reference
ManufacturedItemDefinitionpropertyGeneral characteristics of this item.ManufacturedItemDefinition_Property
ManufacturedItemDefinition_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ManufacturedItemDefinition_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ManufacturedItemDefinition_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ManufacturedItemDefinition_PropertytypeA code expressing the type of characteristic.CodeableConcept
ManufacturedItemDefinition_PropertyvalueCodeableConceptA value for the characteristic.CodeableConcept
ManufacturedItemDefinition_PropertyvalueQuantityA value for the characteristic.Quantity
ManufacturedItemDefinition_PropertyvalueDateA value for the characteristic.notDefined
ManufacturedItemDefinition_Property_valueDateExtensions for valueDateElement
ManufacturedItemDefinition_PropertyvalueBooleanA value for the characteristic.notDefined
ManufacturedItemDefinition_Property_valueBooleanExtensions for valueBooleanElement
ManufacturedItemDefinition_PropertyvalueAttachmentA value for the characteristic.Attachment
MarketingStatusidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MarketingStatusextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MarketingStatusmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
MarketingStatuscountryThe 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
MarketingStatusjurisdictionWhere 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
MarketingStatusstatusThis attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.CodeableConcept
MarketingStatusdateRangeThe 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
MarketingStatusrestoreDateThe 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_restoreDateExtensions for restoreDateElement
MeasureresourceTypeThis is a Measure resourceMeasure
MeasureidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MeasuremetaThe metadata about the resource. 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
MeasureimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MeasurelanguageThe base language in which the resource is written.code
Measure_languageExtensions for languageElement
MeasuretextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MeasurecontainedThese 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
MeasureextensionMay be 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
MeasuremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MeasureurlAn 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_urlExtensions for urlElement
MeasureidentifierA 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
MeasureversionThe 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_versionExtensions for versionElement
MeasurenameA 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_nameExtensions for nameElement
MeasuretitleA short, descriptive, user-friendly title for the measure.string
Measure_titleExtensions for titleElement
MeasurestatusThe status of this measure. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
Measure_statusExtensions for statusElement
MeasureexperimentalA 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_experimentalExtensions for experimentalElement
MeasuredateThe 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_dateExtensions for dateElement
MeasurepublisherThe name of the organization or individual that published the measure.string
Measure_publisherExtensions for publisherElement
MeasurecontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
MeasuredescriptionA free text natural language description of the measure from a consumer's perspective.markdown
Measure_descriptionExtensions for descriptionElement
MeasureuseContextThe 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
MeasurejurisdictionA legal or geographic region in which the measure is intended to be used.CodeableConcept
MeasurepurposeExplanation of why this measure is needed and why it has been designed as it has.markdown
Measure_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
MeasureapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
Measure_approvalDateExtensions for approvalDateElement
MeasurelastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
Measure_lastReviewDateExtensions for lastReviewDateElement
MeasureeffectivePeriodThe period during which the measure content was or is planned to be in active use.Period
MeasuresubtitleAn explanatory or alternate title for the measure giving additional information about its content.string
Measure_subtitleExtensions for subtitleElement
MeasuresubjectCodeableConceptThe 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
MeasuresubjectReferenceThe 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
MeasureusageA detailed description, from a clinical perspective, of how the measure is used.string
Measure_usageExtensions for usageElement
MeasuretopicDescriptive 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
MeasureauthorAn individiual or organization primarily involved in the creation and maintenance of the content.ContactDetail
MeasureeditorAn individual or organization primarily responsible for internal coherence of the content.ContactDetail
MeasurereviewerAn individual or organization primarily responsible for review of some aspect of the content.ContactDetail
MeasureendorserAn individual or organization responsible for officially endorsing the content for use in some setting.ContactDetail
MeasurerelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.RelatedArtifact
MeasurelibraryA reference to a Library resource containing the formal logic used by the measure.canonical
MeasuredisclaimerNotices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.markdown
Measure_disclaimerExtensions for disclaimerElement
MeasurescoringIndicates 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
MeasurecompositeScoringIf this is a composite measure, the scoring method used to combine the component measures to determine the composite score.CodeableConcept
MeasuretypeIndicates 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
MeasureriskAdjustmentA 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_riskAdjustmentExtensions for riskAdjustmentElement
MeasurerateAggregationDescribes how to combine the information calculated, based on logic in each of several populations, into one summarized result.string
Measure_rateAggregationExtensions for rateAggregationElement
MeasurerationaleProvides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.markdown
Measure_rationaleExtensions for rationaleElement
MeasureclinicalRecommendationStatementProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.markdown
Measure_clinicalRecommendationStatementExtensions for clinicalRecommendationStatementElement
MeasureimprovementNotationInformation 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
MeasuredefinitionProvides a description of an individual term used within the measure.markdown
Measure_definitionExtensions for definitionElement
MeasureguidanceAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.markdown
Measure_guidanceExtensions for guidanceElement
MeasuregroupA group of population criteria for the measure.Measure_Group
MeasuresupplementalDataThe 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
MeasureReportresourceTypeThis is a MeasureReport resourceMeasureReport
MeasureReportidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MeasureReportmetaThe metadata about the resource. 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
MeasureReportimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MeasureReportlanguageThe base language in which the resource is written.code
MeasureReport_languageExtensions for languageElement
MeasureReporttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MeasureReportcontainedThese 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
MeasureReportextensionMay be 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
MeasureReportmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MeasureReportidentifierA 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
MeasureReportstatusThe MeasureReport status. No data will be available until the MeasureReport status is complete.enum values:
complete
pending
error
MeasureReport_statusExtensions for statusElement
MeasureReporttypeThe 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_typeExtensions for typeElement
MeasureReportmeasureA reference to the Measure that was calculated to produce this report.canonical
MeasureReportsubjectOptional subject identifying the individual or individuals the report is for.Reference
MeasureReportdateThe date this measure report was generated.dateTime
MeasureReport_dateExtensions for dateElement
MeasureReportreporterThe individual, location, or organization that is reporting the data.Reference
MeasureReportperiodThe reporting period for which the report was calculated.Period
MeasureReportimprovementNotationWhether improvement in the measure is noted by an increase or decrease in the measure score.CodeableConcept
MeasureReportgroupThe results of the calculation, one for each population group in the measure.MeasureReport_Group
MeasureReportevaluatedResourceA reference to a Bundle containing the Resources that were used in the calculation of this measure.Reference
MeasureReport_ComponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MeasureReport_ComponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ComponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ComponentcodeThe code for the stratum component value.CodeableConcept
MeasureReport_ComponentvalueThe stratum component value.CodeableConcept
MeasureReport_GroupidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MeasureReport_GroupextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GroupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GroupcodeThe meaning of the population group as defined in the measure definition.CodeableConcept
MeasureReport_GrouppopulationThe populations that make up the population group, one for each type of population appropriate for the measure.MeasureReport_Population
MeasureReport_GroupmeasureScoreThe 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_GroupstratifierWhen a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.MeasureReport_Stratifier
MeasureReport_PopulationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MeasureReport_PopulationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PopulationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PopulationcodeThe type of the population.CodeableConcept
MeasureReport_PopulationcountThe number of members of the population.integer
MeasureReport_Population_countExtensions for countElement
MeasureReport_PopulationsubjectResultsThis element refers to a List of subject level MeasureReport resources, one for each subject in this population.Reference
MeasureReport_Population1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MeasureReport_Population1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Population1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Population1codeThe type of the population.CodeableConcept
MeasureReport_Population1countThe number of members of the population in this stratum.integer
MeasureReport_Population1_countExtensions for countElement
MeasureReport_Population1subjectResultsThis element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum.Reference
MeasureReport_StratifieridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MeasureReport_StratifierextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StratifiermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StratifiercodeThe meaning of this stratifier, as defined in the measure definition.CodeableConcept
MeasureReport_StratifierstratumThis 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_StratumidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MeasureReport_StratumextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StratummodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StratumvalueThe 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_StratumcomponentA stratifier component value.MeasureReport_Component
MeasureReport_StratumpopulationThe populations that make up the stratum, one for each type of population appropriate to the measure.MeasureReport_Population1
MeasureReport_StratummeasureScoreThe 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_ComponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Measure_ComponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ComponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ComponentcodeIndicates 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_ComponentdescriptionThe human readable description of this stratifier criteria component.string
Measure_Component_descriptionExtensions for descriptionElement
Measure_ComponentcriteriaAn 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_GroupidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Measure_GroupextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GroupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GroupcodeIndicates 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_GroupdescriptionThe human readable description of this population group.string
Measure_Group_descriptionExtensions for descriptionElement
Measure_GrouppopulationA population criteria for the measure.Measure_Population
Measure_GroupstratifierThe 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_PopulationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Measure_PopulationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PopulationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PopulationcodeThe type of population criteria.CodeableConcept
Measure_PopulationdescriptionThe human readable description of this population criteria.string
Measure_Population_descriptionExtensions for descriptionElement
Measure_PopulationcriteriaAn expression that specifies the criteria for the population, typically the name of an expression in a library.Expression
Measure_StratifieridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Measure_StratifierextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StratifiermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StratifiercodeIndicates 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_StratifierdescriptionThe human readable description of this stratifier criteria.string
Measure_Stratifier_descriptionExtensions for descriptionElement
Measure_StratifiercriteriaAn 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_StratifiercomponentA 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_SupplementalDataidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Measure_SupplementalDataextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SupplementalDatamodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SupplementalDatacodeIndicates 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_SupplementalDatausageAn 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_SupplementalDatadescriptionThe human readable description of this supplemental data.string
Measure_SupplementalData_descriptionExtensions for descriptionElement
Measure_SupplementalDatacriteriaThe 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
MedicationresourceTypeThis is a Medication resourceMedication
MedicationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MedicationmetaThe metadata about the resource. 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
MedicationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MedicationlanguageThe base language in which the resource is written.code
Medication_languageExtensions for languageElement
MedicationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MedicationcontainedThese 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
MedicationextensionMay be 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
MedicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MedicationidentifierBusiness identifier for this medication.Identifier
MedicationcodeA 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
MedicationstatusA code to indicate if the medication is in active use.code
Medication_statusExtensions for statusElement
MedicationmanufacturerDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.Reference
MedicationdoseFormDescribes the form of the item. Powder; tablets; capsule.CodeableConcept
MedicationamountSpecific 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
MedicationingredientIdentifies a particular constituent of interest in the product.Medication_Ingredient
MedicationbatchInformation that only applies to packages (not products).Medication_Batch
MedicationAdministrationresourceTypeThis is a MedicationAdministration resourceMedicationAdministration
MedicationAdministrationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MedicationAdministrationmetaThe metadata about the resource. 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
MedicationAdministrationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MedicationAdministrationlanguageThe base language in which the resource is written.code
MedicationAdministration_languageExtensions for languageElement
MedicationAdministrationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MedicationAdministrationcontainedThese 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
MedicationAdministrationextensionMay be 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
MedicationAdministrationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MedicationAdministrationidentifierIdentifiers 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
MedicationAdministrationinstantiatesCanonicalA protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.canonical
MedicationAdministrationinstantiatesUriThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationAdministration.uri
MedicationAdministration_instantiatesUriExtensions for instantiatesUriElement
MedicationAdministrationbasedOnA plan that is fulfilled in whole or in part by this MedicationDispense.Reference
MedicationAdministrationpartOfA larger event of which this particular event is a component or step.Reference
MedicationAdministrationstatusWill 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_statusExtensions for statusElement
MedicationAdministrationstatusReasonA code indicating why the administration was not performed.CodeableConcept
MedicationAdministrationcategoryThe type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).CodeableConcept
MedicationAdministrationmedicationIdentifies 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.CodeableReference
MedicationAdministrationsubjectThe person or animal or group receiving the medication.Reference
MedicationAdministrationencounterThe visit, admission, or other contact between patient and health care provider during which the medication administration was performed.Reference
MedicationAdministrationsupportingInformationAdditional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says "give "x" if the heartrate exceeds "y"", then the heart rate can be included using this attribute.Reference
MedicationAdministrationoccurenceDateTimeA specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.notDefined
MedicationAdministration_occurenceDateTimeExtensions for occurenceDateTimeElement
MedicationAdministrationoccurencePeriodA specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.Period
MedicationAdministrationrecordedThe date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.dateTime
MedicationAdministration_recordedExtensions for recordedElement
MedicationAdministrationperformerIndicates who or what performed the medication administration and how they were involved.MedicationAdministration_Performer
MedicationAdministrationreasonA code, Condition or observation that supports why the medication was administered.CodeableReference
MedicationAdministrationrequestThe original request, instruction or authority to perform the administration.Reference
MedicationAdministrationdeviceThe device used in administering the medication to the patient. For example, a particular infusion pump.Reference
MedicationAdministrationnoteExtra information about the medication administration that is not conveyed by the other attributes.Annotation
MedicationAdministrationdosageDescribes the medication dosage information details e.g. dose, rate, site, route, etc.MedicationAdministration_Dosage
MedicationAdministrationeventHistoryA summary of the events of interest that have occurred, such as when the administration was verified.Reference
MedicationAdministration_DosageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationAdministration_DosageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DosagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DosagetextFree 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_textExtensions for textElement
MedicationAdministration_DosagesiteA coded specification of the anatomic site where the medication first entered the body. For example, "left arm".CodeableConcept
MedicationAdministration_DosagerouteA 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_DosagemethodA 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_DosagedoseThe 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_DosagerateRatioIdentifies 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_DosagerateQuantityIdentifies 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_PerformeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationAdministration_PerformerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PerformermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PerformerfunctionDistinguishes the type of involvement of the performer in the medication administration.CodeableConcept
MedicationAdministration_PerformeractorIndicates who or what performed the medication administration.Reference
MedicationDispenseresourceTypeThis is a MedicationDispense resourceMedicationDispense
MedicationDispenseidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MedicationDispensemetaThe metadata about the resource. 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
MedicationDispenseimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MedicationDispenselanguageThe base language in which the resource is written.code
MedicationDispense_languageExtensions for languageElement
MedicationDispensetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MedicationDispensecontainedThese 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
MedicationDispenseextensionMay be 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
MedicationDispensemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MedicationDispenseidentifierIdentifiers 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
MedicationDispensebasedOnA plan that is fulfilled in whole or in part by this MedicationDispense.Reference
MedicationDispensepartOfThe procedure that trigger the dispense.Reference
MedicationDispensestatusA code specifying the state of the set of dispense events.code
MedicationDispense_statusExtensions for statusElement
MedicationDispensestatusReasonIndicates the reason why a dispense was not performed.CodeableReference
MedicationDispensecategoryIndicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).CodeableConcept
MedicationDispensemedicationIdentifies 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.CodeableReference
MedicationDispensesubjectA link to a resource representing the person or the group to whom the medication will be given.Reference
MedicationDispenseencounterThe encounter that establishes the context for this event.Reference
MedicationDispensesupportingInformationAdditional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented.Reference
MedicationDispenseperformerIndicates who or what performed the event.MedicationDispense_Performer
MedicationDispenselocationThe principal physical location where the dispense was performed.Reference
MedicationDispenseauthorizingPrescriptionIndicates the medication order that is being dispensed against.Reference
MedicationDispensetypeIndicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.CodeableConcept
MedicationDispensequantityThe amount of medication that has been dispensed. Includes unit of measure.Quantity
MedicationDispensedaysSupplyThe amount of medication expressed as a timing amount.Quantity
MedicationDispensewhenPreparedThe time when the dispensed product was packaged and reviewed.dateTime
MedicationDispense_whenPreparedExtensions for whenPreparedElement
MedicationDispensewhenHandedOverThe time the dispensed product was provided to the patient or their representative.dateTime
MedicationDispense_whenHandedOverExtensions for whenHandedOverElement
MedicationDispensedestinationIdentification of the facility/location where the medication was shipped to, as part of the dispense event.Reference
MedicationDispensereceiverIdentifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.Reference
MedicationDispensenoteExtra information about the dispense that could not be conveyed in the other attributes.Annotation
MedicationDispenserenderedDosageInstructionThe full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.string
MedicationDispense_renderedDosageInstructionExtensions for renderedDosageInstructionElement
MedicationDispensedosageInstructionIndicates how the medication is to be used by the patient.Dosage
MedicationDispensesubstitutionIndicates 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
MedicationDispensedetectedIssueIndicates 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
MedicationDispenseeventHistoryA summary of the events of interest that have occurred, such as when the dispense was verified.Reference
MedicationDispense_PerformeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationDispense_PerformerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PerformermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PerformerfunctionDistinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.CodeableConcept
MedicationDispense_PerformeractorThe device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.Reference
MedicationDispense_SubstitutionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationDispense_SubstitutionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubstitutionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubstitutionwasSubstitutedTrue if the dispenser dispensed a different drug or product from what was prescribed.boolean
MedicationDispense_Substitution_wasSubstitutedExtensions for wasSubstitutedElement
MedicationDispense_SubstitutiontypeA code signifying whether a different drug was dispensed from what was prescribed.CodeableConcept
MedicationDispense_SubstitutionreasonIndicates the reason for the substitution (or lack of substitution) from what was prescribed.CodeableConcept
MedicationDispense_SubstitutionresponsiblePartyThe person or organization that has primary responsibility for the substitution.Reference
MedicationKnowledgeresourceTypeThis is a MedicationKnowledge resourceMedicationKnowledge
MedicationKnowledgeidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MedicationKnowledgemetaThe metadata about the resource. 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
MedicationKnowledgeimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MedicationKnowledgelanguageThe base language in which the resource is written.code
MedicationKnowledge_languageExtensions for languageElement
MedicationKnowledgetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MedicationKnowledgecontainedThese 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
MedicationKnowledgeextensionMay be 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
MedicationKnowledgemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MedicationKnowledgeidentifierBusiness identifier for this medication.Identifier
MedicationKnowledgecodeA 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
MedicationKnowledgestatusA 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_statusExtensions for statusElement
MedicationKnowledgemanufacturerDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.Reference
MedicationKnowledgedoseFormDescribes the form of the item. Powder; tablets; capsule.CodeableConcept
MedicationKnowledgeamountSpecific 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
MedicationKnowledgesynonymAdditional 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_synonymExtensions for synonymElement
MedicationKnowledgerelatedMedicationKnowledgeAssociated or related knowledge about a medication.MedicationKnowledge_RelatedMedicationKnowledge
MedicationKnowledgeassociatedMedicationAssociated 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
MedicationKnowledgeproductTypeCategory of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).CodeableConcept
MedicationKnowledgemonographAssociated documentation about the medication.MedicationKnowledge_Monograph
MedicationKnowledgeingredientIdentifies a particular constituent of interest in the product.MedicationKnowledge_Ingredient
MedicationKnowledgedeviceA device associated with the medication (for example, a drug coated catheter or a drug impregnated dressing).Reference
MedicationKnowledgepreparationInstructionThe instructions for preparing the medication.markdown
MedicationKnowledge_preparationInstructionExtensions for preparationInstructionElement
MedicationKnowledgeintendedRouteThe intended or approved route of administration.CodeableConcept
MedicationKnowledgecostThe price of the medication.MedicationKnowledge_Cost
MedicationKnowledgemonitoringProgramThe program under which the medication is reviewed.MedicationKnowledge_MonitoringProgram
MedicationKnowledgeadministrationGuidelineGuidelines or protocols that are applicable for the administration of the medication.MedicationKnowledge_AdministrationGuideline
MedicationKnowledgemedicineClassificationCategorization of the medication within a formulary or classification system.MedicationKnowledge_MedicineClassification
MedicationKnowledgepackagingInformation that only applies to packages (not products).MedicationKnowledge_Packaging
MedicationKnowledgedrugCharacteristicSpecifies descriptive properties of the medicine, such as color, shape, imprints, etc.MedicationKnowledge_DrugCharacteristic
MedicationKnowledgeclinicalUseIssuePotential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).Reference
MedicationKnowledgeregulatoryRegulatory information about a medication.MedicationKnowledge_Regulatory
MedicationKnowledgekineticCharacteristicThe time course of drug absorption, distribution, metabolism and excretion of a medication from the body.MedicationKnowledge_KineticCharacteristic
MedicationKnowledge_AdministrationGuidelineidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_AdministrationGuidelineextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AdministrationGuidelinemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AdministrationGuidelinedosageDosage for the medication for the specific guidelines.MedicationKnowledge_Dosage
MedicationKnowledge_AdministrationGuidelineindicationIndication or reason for use of the medication that applies to the specific administration guidelines.CodeableReference
MedicationKnowledge_AdministrationGuidelinepatientCharacteristicCharacteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).MedicationKnowledge_PatientCharacteristic
MedicationKnowledge_CostidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_CostextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CostmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CosttypeThe category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.CodeableConcept
MedicationKnowledge_CostsourceThe source or owner that assigns the price to the medication.string
MedicationKnowledge_Cost_sourceExtensions for sourceElement
MedicationKnowledge_CostcostThe price of the medication.Money
MedicationKnowledge_DosageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_DosageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DosagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DosagetypeThe type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).CodeableConcept
MedicationKnowledge_DosagedosageDosage for the medication for the specific guidelines.Dosage
MedicationKnowledge_DrugCharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_DrugCharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DrugCharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DrugCharacteristictypeA code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).CodeableConcept
MedicationKnowledge_DrugCharacteristicvalueCodeableConceptDescription of the characteristic.CodeableConcept
MedicationKnowledge_DrugCharacteristicvalueStringDescription of the characteristic.notDefined
MedicationKnowledge_DrugCharacteristic_valueStringExtensions for valueStringElement
MedicationKnowledge_DrugCharacteristicvalueQuantityDescription of the characteristic.Quantity
MedicationKnowledge_DrugCharacteristicvalueBase64BinaryDescription of the characteristic.notDefined
MedicationKnowledge_DrugCharacteristic_valueBase64BinaryExtensions for valueBase64BinaryElement
MedicationKnowledge_DrugCharacteristicvalueAttachmentDescription of the characteristic.Attachment
MedicationKnowledge_IngredientidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_IngredientextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_IngredientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_IngredientitemThe actual ingredient - either a substance (simple ingredient) or another medication.CodeableReference
MedicationKnowledge_IngredientisActiveIndication of whether this ingredient affects the therapeutic action of the drug.boolean
MedicationKnowledge_Ingredient_isActiveExtensions for isActiveElement
MedicationKnowledge_IngredientstrengthRatioSpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.Ratio
MedicationKnowledge_IngredientstrengthCodeableConceptSpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.CodeableConcept
MedicationKnowledge_IngredientstrengthQuantitySpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.Quantity
MedicationKnowledge_KineticCharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_KineticCharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_KineticCharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_KineticCharacteristictypeCode specifying the type of kinetics (e.g. area under the curve, half life period, lethal dose 50.).CodeableConcept
MedicationKnowledge_KineticCharacteristicvalueQuantityDescription of the characteristic.Quantity
MedicationKnowledge_KineticCharacteristicvalueDurationDescription of the characteristic.Duration
MedicationKnowledge_MaxDispenseidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_MaxDispenseextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MaxDispensemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MaxDispensequantityThe maximum number of units of the medication that can be dispensed.Quantity
MedicationKnowledge_MaxDispenseperiodThe period that applies to the maximum number of units.Duration
MedicationKnowledge_MedicineClassificationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_MedicineClassificationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MedicineClassificationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MedicineClassificationtypeThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).CodeableConcept
MedicationKnowledge_MedicineClassificationclassificationSpecific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).CodeableConcept
MedicationKnowledge_MonitoringProgramidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_MonitoringProgramextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MonitoringProgrammodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MonitoringProgramtypeType of program under which the medication is monitored.CodeableConcept
MedicationKnowledge_MonitoringProgramnameName of the reviewing program.string
MedicationKnowledge_MonitoringProgram_nameExtensions for nameElement
MedicationKnowledge_MonographidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_MonographextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MonographmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MonographtypeThe category of documentation about the medication. (e.g. professional monograph, patient education monograph).CodeableConcept
MedicationKnowledge_MonographsourceAssociated documentation about the medication.Reference
MedicationKnowledge_PackagingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_PackagingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PackagingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PackagingtypeA code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).CodeableConcept
MedicationKnowledge_PackagingquantityThe number of product units the package would contain if fully loaded.Quantity
MedicationKnowledge_PackagingdeviceThe device used to administer the medication (e.g. scoop, applicator, syringe).Reference
MedicationKnowledge_PackagingmaterialMaterial type of the package item.CodeableConcept
MedicationKnowledge_PackagingpackagingAllows packages within packages (e.g. blister packages within a box or vials of medications within a box).MedicationKnowledge_Packaging
MedicationKnowledge_PatientCharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_PatientCharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PatientCharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PatientCharacteristictypeThe categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).CodeableConcept
MedicationKnowledge_PatientCharacteristicvalueCodeableConceptThe specific characteristic (e.g. height, weight, gender, etc.).CodeableConcept
MedicationKnowledge_PatientCharacteristicvalueQuantityThe specific characteristic (e.g. height, weight, gender, etc.).Quantity
MedicationKnowledge_RegulatoryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_RegulatoryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RegulatorymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RegulatoryregulatoryAuthorityThe authority that is specifying the regulations.Reference
MedicationKnowledge_RegulatorysubstitutionSpecifies if changes are allowed when dispensing a medication from a regulatory perspective.MedicationKnowledge_Substitution
MedicationKnowledge_RegulatoryscheduleSpecifies the schedule of a medication in jurisdiction.CodeableConcept
MedicationKnowledge_RegulatorymaxDispenseThe maximum number of units of the medication that can be dispensed in a period.MedicationKnowledge_MaxDispense
MedicationKnowledge_RelatedMedicationKnowledgeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_RelatedMedicationKnowledgeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RelatedMedicationKnowledgemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RelatedMedicationKnowledgetypeThe category of the associated medication knowledge reference.CodeableConcept
MedicationKnowledge_RelatedMedicationKnowledgereferenceAssociated documentation about the associated medication knowledge.Reference
MedicationKnowledge_SubstitutionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationKnowledge_SubstitutionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubstitutionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubstitutiontypeSpecifies the type of substitution allowed.CodeableConcept
MedicationKnowledge_SubstitutionallowedSpecifies if regulation allows for changes in the medication when dispensing.boolean
MedicationKnowledge_Substitution_allowedExtensions for allowedElement
MedicationRequestresourceTypeThis is a MedicationRequest resourceMedicationRequest
MedicationRequestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MedicationRequestmetaThe metadata about the resource. 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
MedicationRequestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MedicationRequestlanguageThe base language in which the resource is written.code
MedicationRequest_languageExtensions for languageElement
MedicationRequesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MedicationRequestcontainedThese 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
MedicationRequestextensionMay be 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
MedicationRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MedicationRequestidentifierIdentifiers 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
MedicationRequeststatusA code specifying the current state of the order. Generally, this will be active or completed state.code
MedicationRequest_statusExtensions for statusElement
MedicationRequeststatusReasonCaptures the reason for the current state of the MedicationRequest.CodeableConcept
MedicationRequestintentWhether the request is a proposal, plan, or an original order.code
MedicationRequest_intentExtensions for intentElement
MedicationRequestcategoryIndicates the grouping or category of medication request (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).CodeableConcept
MedicationRequestpriorityIndicates how quickly the Medication Request should be addressed with respect to other requests.code
MedicationRequest_priorityExtensions for priorityElement
MedicationRequestdoNotPerformIf true indicates that the provider is asking for the medication request not to occur.boolean
MedicationRequest_doNotPerformExtensions for doNotPerformElement
MedicationRequestreportedIndicates 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.boolean
MedicationRequest_reportedExtensions for reportedElement
MedicationRequestinformationSourceThe person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.Reference
MedicationRequestmedicationIdentifies 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.CodeableReference
MedicationRequestsubjectA link to a resource representing the person or set of individuals to whom the medication will be given.Reference
MedicationRequestencounterThe Encounter during which this [x] was created or to which the creation of this record is tightly associated.Reference
MedicationRequestsupportingInformationInclude additional information (for example, patient height and weight, a MedicationUsage for the patient) that supports the ordering of the medication.Reference
MedicationRequestauthoredOnThe date (and perhaps time) when the prescription was initially written or authored on.dateTime
MedicationRequest_authoredOnExtensions for authoredOnElement
MedicationRequestrequesterThe individual, organization, or device that initiated the request and has responsibility for its activation.Reference
MedicationRequestperformerThe specified desired performer of the medication treatment (e.g. the performer of the medication administration).Reference
MedicationRequestperformerTypeIndicates the type of performer of the administration of the medication.CodeableConcept
MedicationRequestrecorderThe person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.Reference
MedicationRequestreasonThe reason or the indication for ordering or not ordering the medication.CodeableReference
MedicationRequestinstantiatesCanonicalThe URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.canonical
MedicationRequestinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
MedicationRequestbasedOnA plan or request that is fulfilled in whole or in part by this medication request.Reference
MedicationRequestgroupIdentifierA 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
MedicationRequestcourseOfTherapyTypeThe description of the overall pattern of the administration of the medication to the patient.CodeableConcept
MedicationRequestinsuranceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.Reference
MedicationRequestnoteExtra information about the prescription that could not be conveyed by the other attributes.Annotation
MedicationRequestrenderedDosageInstructionThe full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.string
MedicationRequest_renderedDosageInstructionExtensions for renderedDosageInstructionElement
MedicationRequestdosageInstructionIndicates how the medication is to be used by the patient.Dosage
MedicationRequestdispenseRequestIndicates 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
MedicationRequestsubstitutionIndicates 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
MedicationRequestpriorPrescriptionA link to a resource representing an earlier order related order or prescription.Reference
MedicationRequestdetectedIssueIndicates 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
MedicationRequesteventHistoryLinks 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_DispenseRequestidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationRequest_DispenseRequestextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DispenseRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DispenseRequestinitialFillIndicates the quantity or duration for the first dispense of the medication.MedicationRequest_InitialFill
MedicationRequest_DispenseRequestdispenseIntervalThe minimum period of time that must occur between dispenses of the medication.Duration
MedicationRequest_DispenseRequestvalidityPeriodThis indicates the validity period of a prescription (stale dating the Prescription).Period
MedicationRequest_DispenseRequestnumberOfRepeatsAllowedAn 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_numberOfRepeatsAllowedExtensions for numberOfRepeatsAllowedElement
MedicationRequest_DispenseRequestquantityThe amount that is to be dispensed for one fill.Quantity
MedicationRequest_DispenseRequestexpectedSupplyDurationIdentifies 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_DispenseRequestdispenserIndicates the intended performing Organization that will dispense the medication as specified by the prescriber.Reference
MedicationRequest_InitialFillidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationRequest_InitialFillextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InitialFillmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InitialFillquantityThe amount or quantity to provide as part of the first dispense.Quantity
MedicationRequest_InitialFilldurationThe length of time that the first dispense is expected to last.Duration
MedicationRequest_SubstitutionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicationRequest_SubstitutionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubstitutionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubstitutionallowedBooleanTrue if the prescriber allows a different drug to be dispensed from what was prescribed.notDefined
MedicationRequest_Substitution_allowedBooleanExtensions for allowedBooleanElement
MedicationRequest_SubstitutionallowedCodeableConceptTrue if the prescriber allows a different drug to be dispensed from what was prescribed.CodeableConcept
MedicationRequest_SubstitutionreasonIndicates the reason for the substitution, or why substitution must or must not be performed.CodeableConcept
MedicationUsageresourceTypeThis is a MedicationUsage resourceMedicationUsage
MedicationUsageidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MedicationUsagemetaThe metadata about the resource. 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
MedicationUsageimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
MedicationUsage_implicitRulesExtensions for implicitRulesElement
MedicationUsagelanguageThe base language in which the resource is written.code
MedicationUsage_languageExtensions for languageElement
MedicationUsagetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MedicationUsagecontainedThese 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
MedicationUsageextensionMay be 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
MedicationUsagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MedicationUsageidentifierIdentifiers associated with this Medication Usage 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
MedicationUsagebasedOnA plan, proposal or order that is fulfilled in whole or in part by this event.Reference
MedicationUsagepartOfA larger event of which this particular event is a component or step.Reference
MedicationUsagestatusA code representing the patient or other source's judgment about the state of the medication used that this usage is about. Generally, this will be active or completed.code
MedicationUsage_statusExtensions for statusElement
MedicationUsagestatusReasonCaptures the reason for the current state of the MedicationUsage.CodeableConcept
MedicationUsagecategoryType of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).CodeableConcept
MedicationUsagemedicationIdentifies 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.CodeableReference
MedicationUsagesubjectThe person, animal or group who is/was taking the medication.Reference
MedicationUsageencounterThe encounter that establishes the context for this MedicationUsage.Reference
MedicationUsageeffectiveDateTimeThe 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 MedicationUsage.status element is NotTaken).notDefined
MedicationUsage_effectiveDateTimeExtensions for effectiveDateTimeElement
MedicationUsageeffectivePeriodThe 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 MedicationUsage.status element is NotTaken).Period
MedicationUsagedateAssertedThe date when the Medication Usage was asserted by the information source.dateTime
MedicationUsage_dateAssertedExtensions for dateAssertedElement
MedicationUsageinformationSourceThe person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationUsage is derived from other resources, e.g. Claim or MedicationRequest.Reference
MedicationUsagederivedFromAllows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.Reference
MedicationUsagereasonA concept, Condition or observation that supports why the medication is being/was taken.CodeableReference
MedicationUsagenoteProvides extra information about the Medication Usage that is not conveyed by the other attributes.Annotation
MedicationUsagerenderedDosageInstructionThe full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.string
MedicationUsage_renderedDosageInstructionExtensions for renderedDosageInstructionElement
MedicationUsagedosageIndicates how the medication is/was or should be taken by the patient.Dosage
MedicationUsagetakenAsOrderedIndicates if the medication is being consumed or administered as prescribed.boolean
MedicationUsage_takenAsOrderedExtensions for takenAsOrderedElement
Medication_BatchidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Medication_BatchextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_BatchmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_BatchlotNumberThe assigned lot number of a batch of the specified product.string
Medication_Batch_lotNumberExtensions for lotNumberElement
Medication_BatchexpirationDateWhen this specific batch of product will expire.dateTime
Medication_Batch_expirationDateExtensions for expirationDateElement
Medication_IngredientidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Medication_IngredientextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_IngredientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_IngredientitemThe ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).CodeableReference
Medication_IngredientisActiveIndication of whether this ingredient affects the therapeutic action of the drug.boolean
Medication_Ingredient_isActiveExtensions for isActiveElement
Medication_IngredientstrengthRatioSpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.Ratio
Medication_IngredientstrengthCodeableConceptSpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.CodeableConcept
Medication_IngredientstrengthQuantitySpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.Quantity
MedicinalProductDefinitionresourceTypeThis is a MedicinalProductDefinition resourceMedicinalProductDefinition
MedicinalProductDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MedicinalProductDefinitionmetaThe metadata about the resource. 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
MedicinalProductDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
MedicinalProductDefinition_implicitRulesExtensions for implicitRulesElement
MedicinalProductDefinitionlanguageThe base language in which the resource is written.code
MedicinalProductDefinition_languageExtensions for languageElement
MedicinalProductDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MedicinalProductDefinitioncontainedThese 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
MedicinalProductDefinitionextensionMay be 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
MedicinalProductDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MedicinalProductDefinitionidentifierBusiness identifier for this product. Could be an MPID.Identifier
MedicinalProductDefinitiontypeRegulatory type, e.g. Investigational or Authorized.CodeableConcept
MedicinalProductDefinitiondomainIf this medicine applies to human or veterinary uses.CodeableConcept
MedicinalProductDefinitionversionA business level identifier of the product.string
MedicinalProductDefinition_versionExtensions for versionElement
MedicinalProductDefinitionstatusThe status within the lifecycle of this product. A high level status, this is not intended to duplicate details carried elswhere such as legal status, or authorization status.CodeableConcept
MedicinalProductDefinitionstatusDateThe date at which the given status became applicable.dateTime
MedicinalProductDefinition_statusDateExtensions for statusDateElement
MedicinalProductDefinitiondescriptionGeneral description of this product.markdown
MedicinalProductDefinition_descriptionExtensions for descriptionElement
MedicinalProductDefinitioncombinedPharmaceuticalDoseFormThe dose form for a single part product, or combined form of a multiple part product.CodeableConcept
MedicinalProductDefinitionindicationGeneral combined description of indication(s) for this product. See also MedicinalProductDefinitionIndication.markdown
MedicinalProductDefinition_indicationExtensions for indicationElement
MedicinalProductDefinitionlegalStatusOfSupplyThe legal status of supply of the medicinal product as classified by the regulator.CodeableConcept
MedicinalProductDefinitionadditionalMonitoringIndicatorWhether the Medicinal Product is subject to additional monitoring for regulatory reasons.CodeableConcept
MedicinalProductDefinitionspecialMeasuresWhether the Medicinal Product is subject to special measures for regulatory reasons.CodeableConcept
MedicinalProductDefinitionpaediatricUseIndicatorIf authorised for use in children.CodeableConcept
MedicinalProductDefinitionproductClassificationAllows the product to be classified by various systems.CodeableConcept
MedicinalProductDefinitioncharacteristicAllows the key product features to be recorded, such as "suger free", "modified release", "parallel import".CodeableConcept
MedicinalProductDefinitionmarketingStatusMarketing status of the medicinal product, in contrast to marketing authorizaton.MarketingStatus
MedicinalProductDefinitionpharmaceuticalProductPharmaceutical aspects of product.Reference
MedicinalProductDefinitionpackagedMedicinalProductPackage representation for the product.Reference
MedicinalProductDefinitioningredientThe ingredients of this medicinal product - when not specified elsewhere. This is only needed if the ingredients are not specified by the pharmaceuticalProduct or packagedMedicinalProduct references above. In cases where those levels of detail are not used, the ingredients may be specified directly here.Reference
MedicinalProductDefinitionattachedDocumentSupporting documentation, typically for regulatory submission.Reference
MedicinalProductDefinitionmasterFileA master file for to the medicinal product (e.g. Pharmacovigilance System Master File).Reference
MedicinalProductDefinitioncontactA product specific contact, person (in a role), or an organization.MedicinalProductDefinition_Contact
MedicinalProductDefinitionclinicalTrialClinical trials or studies that this product is involved in.Reference
MedicinalProductDefinitionnameThe product's name, including full name and possibly coded parts.MedicinalProductDefinition_Name
MedicinalProductDefinitioncrossReferenceReference to another product, e.g. for linking authorised to investigational product.MedicinalProductDefinition_CrossReference
MedicinalProductDefinitionmanufacturingBusinessOperationAn operation applied to the product, for manufacturing or adminsitrative purpose.MedicinalProductDefinition_ManufacturingBusinessOperation
MedicinalProductDefinition_ContactidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicinalProductDefinition_ContactextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MedicinalProductDefinition_ContactmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
MedicinalProductDefinition_ContacttypeAllows the contact to be classified, for example QPPV, Pharmacovigilence Enquiry Information.CodeableConcept
MedicinalProductDefinition_ContactcontactA product specific contact, person (in a role), or an organization.Reference
MedicinalProductDefinition_CountryLanguageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicinalProductDefinition_CountryLanguageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MedicinalProductDefinition_CountryLanguagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
MedicinalProductDefinition_CountryLanguagecountryCountry code for where this name applies.CodeableConcept
MedicinalProductDefinition_CountryLanguagejurisdictionJurisdiction code for where this name applies.CodeableConcept
MedicinalProductDefinition_CountryLanguagelanguageLanguage code for this name.CodeableConcept
MedicinalProductDefinition_CrossReferenceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicinalProductDefinition_CrossReferenceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MedicinalProductDefinition_CrossReferencemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
MedicinalProductDefinition_CrossReferenceproductIdentifierReference to another product, e.g. for linking authorised to investigational product.Identifier
MedicinalProductDefinition_CrossReferenceproductReferenceReference to another product, e.g. for linking authorised to investigational product.Reference
MedicinalProductDefinition_CrossReferencetypeThe type of relationship, for instance branded to generic, product to development product (investigational), parallel import version.CodeableConcept
MedicinalProductDefinition_ManufacturingBusinessOperationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicinalProductDefinition_ManufacturingBusinessOperationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MedicinalProductDefinition_ManufacturingBusinessOperationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
MedicinalProductDefinition_ManufacturingBusinessOperationtypeThe type of manufacturing operation e.g. manufacturing itself, re-packaging. This may be a subtype of some other wider scope of authorized operation, referenced by the authorization attribute.CodeableReference
MedicinalProductDefinition_ManufacturingBusinessOperationeffectiveDateDate range of applicability.Period
MedicinalProductDefinition_ManufacturingBusinessOperationmanufacturerThe manufacturer or establishment associated with the process.Reference
MedicinalProductDefinition_ManufacturingBusinessOperationauthorizationAn authorization for this process, either as a logical reference, holding just an identifier, or a full refererence to a resource that captures the details. The authorization mayu possibly apply to several products or a wider scope of process of which this is a part.Reference
MedicinalProductDefinition_ManufacturingBusinessOperationconfidentialityIndicatorTo indicate if this proces is commercially confidential.CodeableConcept
MedicinalProductDefinition_NameidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicinalProductDefinition_NameextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MedicinalProductDefinition_NamemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
MedicinalProductDefinition_NameproductNameThe full product name.string
MedicinalProductDefinition_Name_productNameExtensions for productNameElement
MedicinalProductDefinition_NametypeType of product name, such as rINN, BAN, Proprietary, Non-Proprietary.CodeableConcept
MedicinalProductDefinition_NamenamePartCoding words or phrases of the name.MedicinalProductDefinition_NamePart
MedicinalProductDefinition_NamecountryLanguageCountry where the name applies.MedicinalProductDefinition_CountryLanguage
MedicinalProductDefinition_NamePartidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MedicinalProductDefinition_NamePartextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MedicinalProductDefinition_NamePartmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
MedicinalProductDefinition_NamePartpartA fragment of a product name.string
MedicinalProductDefinition_NamePart_partExtensions for partElement
MedicinalProductDefinition_NameParttypeIdenifying type for this part of the name (e.g. strength part).CodeableConcept
MessageDefinitionresourceTypeThis is a MessageDefinition resourceMessageDefinition
MessageDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MessageDefinitionmetaThe metadata about the resource. 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
MessageDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MessageDefinitionlanguageThe base language in which the resource is written.code
MessageDefinition_languageExtensions for languageElement
MessageDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MessageDefinitioncontainedThese 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
MessageDefinitionextensionMay be 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
MessageDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MessageDefinitionurlThe business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.uri
MessageDefinition_urlExtensions for urlElement
MessageDefinitionidentifierA 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
MessageDefinitionversionThe 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_versionExtensions for versionElement
MessageDefinitionnameA 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_nameExtensions for nameElement
MessageDefinitiontitleA short, descriptive, user-friendly title for the message definition.string
MessageDefinition_titleExtensions for titleElement
MessageDefinitionstatusThe status of this message definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
MessageDefinition_statusExtensions for statusElement
MessageDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
MessageDefinitiondateThe 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_dateExtensions for dateElement
MessageDefinitionpublisherThe name of the organization or individual that published the message definition.string
MessageDefinition_publisherExtensions for publisherElement
MessageDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
MessageDefinitiondescriptionA free text natural language description of the message definition from a consumer's perspective.markdown
MessageDefinition_descriptionExtensions for descriptionElement
MessageDefinitionuseContextThe 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
MessageDefinitionjurisdictionA legal or geographic region in which the message definition is intended to be used.CodeableConcept
MessageDefinitionpurposeExplanation of why this message definition is needed and why it has been designed as it has.markdown
MessageDefinition_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
MessageDefinitionreplacesA MessageDefinition that is superseded by this definition.canonical
MessageDefinitionbaseThe MessageDefinition that is the basis for the contents of this resource.canonical
MessageDefinitionparentIdentifies a protocol or workflow that this MessageDefinition represents a step in.canonical
MessageDefinitioneventCodingEvent code or link to the EventDefinition.Coding
MessageDefinitioneventUriEvent code or link to the EventDefinition.notDefined
MessageDefinition_eventUriExtensions for eventUriElement
MessageDefinitioncategoryThe impact of the content of the message.enum values:
consequence
currency
notification
MessageDefinition_categoryExtensions for categoryElement
MessageDefinitionfocusIdentifies 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
MessageDefinitionresponseRequiredDeclare 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_responseRequiredExtensions for responseRequiredElement
MessageDefinitionallowedResponseIndicates what types of messages may be sent as an application-level response to this message.MessageDefinition_AllowedResponse
MessageDefinitiongraphCanonical 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_AllowedResponseidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MessageDefinition_AllowedResponseextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AllowedResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AllowedResponsemessageA reference to the message definition that must be adhered to by this supported response.canonical
MessageDefinition_AllowedResponsesituationProvides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).markdown
MessageDefinition_AllowedResponse_situationExtensions for situationElement
MessageDefinition_FocusidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MessageDefinition_FocusextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FocusmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FocuscodeThe kind of resource that must be the focus for this message.code
MessageDefinition_Focus_codeExtensions for codeElement
MessageDefinition_FocusprofileA profile that reflects constraints for the focal resource (and potentially for related resources).canonical
MessageDefinition_FocusminIdentifies 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_minExtensions for minElement
MessageDefinition_FocusmaxIdentifies 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_maxExtensions for maxElement
MessageHeaderresourceTypeThis is a MessageHeader resourceMessageHeader
MessageHeaderidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MessageHeadermetaThe metadata about the resource. 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
MessageHeaderimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MessageHeaderlanguageThe base language in which the resource is written.code
MessageHeader_languageExtensions for languageElement
MessageHeadertextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MessageHeadercontainedThese 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
MessageHeaderextensionMay be 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
MessageHeadermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MessageHeadereventCodingCode 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
MessageHeadereventUriCode 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_eventUriExtensions for eventUriElement
MessageHeaderdestinationThe destination application which the message is intended for.MessageHeader_Destination
MessageHeadersenderIdentifies the sending system to allow the use of a trust relationship.Reference
MessageHeaderentererThe 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
MessageHeaderauthorThe 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
MessageHeadersourceThe source application from which this message originated.MessageHeader_Source
MessageHeaderresponsibleThe 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
MessageHeaderreasonCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.CodeableConcept
MessageHeaderresponseInformation about the message that this message is a response to. Only present if this message is a response.MessageHeader_Response
MessageHeaderfocusThe actual data of the message - a reference to the root/focus class of the event.Reference
MessageHeaderdefinitionPermanent link to the MessageDefinition for this message.canonical
MessageHeader_DestinationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MessageHeader_DestinationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DestinationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DestinationnameHuman-readable name for the target system.string
MessageHeader_Destination_nameExtensions for nameElement
MessageHeader_DestinationtargetIdentifies the target end system in situations where the initial message transmission is to an intermediary system.Reference
MessageHeader_DestinationendpointIndicates where the message should be routed to.url
MessageHeader_Destination_endpointExtensions for endpointElement
MessageHeader_DestinationreceiverAllows 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_ResponseidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MessageHeader_ResponseextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ResponseidentifierThe MessageHeader.id of the message to which this message is a response.id
MessageHeader_Response_identifierExtensions for identifierElement
MessageHeader_ResponsecodeCode 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_codeExtensions for codeElement
MessageHeader_ResponsedetailsFull details of any issues found in the message.Reference
MessageHeader_SourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MessageHeader_SourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SourcenameHuman-readable name for the source system.string
MessageHeader_Source_nameExtensions for nameElement
MessageHeader_SourcesoftwareMay include configuration or other information useful in debugging.string
MessageHeader_Source_softwareExtensions for softwareElement
MessageHeader_SourceversionCan convey versions of multiple systems in situations where a message passes through multiple hands.string
MessageHeader_Source_versionExtensions for versionElement
MessageHeader_SourcecontactAn e-mail, phone, website or other contact point to use to resolve issues with message communications.ContactPoint
MessageHeader_SourceendpointIdentifies the routing target to send acknowledgements to.url
MessageHeader_Source_endpointExtensions for endpointElement
MetaidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MetaextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MetaversionIdThe 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_versionIdExtensions for versionIdElement
MetalastUpdatedWhen the resource last changed - e.g. when the version changed.instant
Meta_lastUpdatedExtensions for lastUpdatedElement
MetasourceA 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_sourceExtensions for sourceElement
MetaprofileA list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].canonical
MetasecuritySecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.Coding
MetatagTags 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
MolecularSequenceresourceTypeThis is a MolecularSequence resourceMolecularSequence
MolecularSequenceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
MolecularSequencemetaThe metadata about the resource. 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
MolecularSequenceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
MolecularSequencelanguageThe base language in which the resource is written.code
MolecularSequence_languageExtensions for languageElement
MolecularSequencetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
MolecularSequencecontainedThese 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
MolecularSequenceextensionMay be 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
MolecularSequencemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
MolecularSequenceidentifierA unique identifier for this particular sequence instance. This is a FHIR-defined id.Identifier
MolecularSequencetypeAmino Acid Sequence/ DNA Sequence / RNA Sequence.enum values:
aa
dna
rna
MolecularSequence_typeExtensions for typeElement
MolecularSequencecoordinateSystemWhether 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_coordinateSystemExtensions for coordinateSystemElement
MolecularSequencepatientThe patient whose sequencing results are described by this resource.Reference
MolecularSequencespecimenSpecimen used for sequencing.Reference
MolecularSequencedeviceThe method for sequencing, for example, chip information.Reference
MolecularSequenceperformerThe organization or lab that should be responsible for this result.Reference
MolecularSequencequantityThe number of copies of the sequence of interest. (RNASeq).Quantity
MolecularSequencereferenceSeqA sequence that is used as a reference to describe variants that are present in a sequence analyzed.MolecularSequence_ReferenceSeq
MolecularSequencevariantThe 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
MolecularSequenceobservedSeqSequence 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_observedSeqExtensions for observedSeqElement
MolecularSequencequalityAn 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
MolecularSequencereadCoverageCoverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.integer
MolecularSequence_readCoverageExtensions for readCoverageElement
MolecularSequencerepositoryConfigurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.MolecularSequence_Repository
MolecularSequencepointerPointer to next atomic sequence which at most contains one variant.Reference
MolecularSequencestructureVariantInformation about chromosome structure variation.MolecularSequence_StructureVariant
MolecularSequence_InneridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_InnerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InnermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InnerstartStructural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.integer
MolecularSequence_Inner_startExtensions for startElement
MolecularSequence_InnerendStructural 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_endExtensions for endElement
MolecularSequence_OuteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_OuterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OutermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OuterstartStructural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.integer
MolecularSequence_Outer_startExtensions for startElement
MolecularSequence_OuterendStructural 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_endExtensions for endElement
MolecularSequence_QualityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_QualityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_QualitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_QualitytypeINDEL / SNP / Undefined variant.enum values:
indel
snp
unknown
MolecularSequence_Quality_typeExtensions for typeElement
MolecularSequence_QualitystandardSequenceGold standard sequence used for comparing against.CodeableConcept
MolecularSequence_QualitystartStart position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.integer
MolecularSequence_Quality_startExtensions for startElement
MolecularSequence_QualityendEnd 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_endExtensions for endElement
MolecularSequence_QualityscoreThe 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_QualitymethodWhich method is used to get sequence quality.CodeableConcept
MolecularSequence_QualitytruthTPTrue 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_truthTPExtensions for truthTPElement
MolecularSequence_QualityqueryTPTrue 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_queryTPExtensions for queryTPElement
MolecularSequence_QualitytruthFNFalse 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_truthFNExtensions for truthFNElement
MolecularSequence_QualityqueryFPFalse 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_queryFPExtensions for queryFPElement
MolecularSequence_QualitygtFPThe 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_gtFPExtensions for gtFPElement
MolecularSequence_QualityprecisionQUERY.TP / (QUERY.TP + QUERY.FP).decimal
MolecularSequence_Quality_precisionExtensions for precisionElement
MolecularSequence_QualityrecallTRUTH.TP / (TRUTH.TP + TRUTH.FN).decimal
MolecularSequence_Quality_recallExtensions for recallElement
MolecularSequence_QualityfScoreHarmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).decimal
MolecularSequence_Quality_fScoreExtensions for fScoreElement
MolecularSequence_QualityrocReceiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.MolecularSequence_Roc
MolecularSequence_ReferenceSeqidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_ReferenceSeqextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ReferenceSeqmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ReferenceSeqchromosomeStructural 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_ReferenceSeqgenomeBuildThe 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_genomeBuildExtensions for genomeBuildElement
MolecularSequence_ReferenceSeqorientationA 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_orientationExtensions for orientationElement
MolecularSequence_ReferenceSeqreferenceSeqIdReference 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_ReferenceSeqreferenceSeqPointerA pointer to another MolecularSequence entity as reference sequence.Reference
MolecularSequence_ReferenceSeqreferenceSeqStringA string like "ACGT".string
MolecularSequence_ReferenceSeq_referenceSeqStringExtensions for referenceSeqStringElement
MolecularSequence_ReferenceSeqstrandAn 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_strandExtensions for strandElement
MolecularSequence_ReferenceSeqwindowStartStart 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_windowStartExtensions for windowStartElement
MolecularSequence_ReferenceSeqwindowEndEnd 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_windowEndExtensions for windowEndElement
MolecularSequence_RepositoryidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_RepositoryextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RepositorymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RepositorytypeClick 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_typeExtensions for typeElement
MolecularSequence_RepositoryurlURI of an external repository which contains further details about the genetics data.uri
MolecularSequence_Repository_urlExtensions for urlElement
MolecularSequence_RepositorynameURI of an external repository which contains further details about the genetics data.string
MolecularSequence_Repository_nameExtensions for nameElement
MolecularSequence_RepositorydatasetIdId 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_datasetIdExtensions for datasetIdElement
MolecularSequence_RepositoryvariantsetIdId 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_variantsetIdExtensions for variantsetIdElement
MolecularSequence_RepositoryreadsetIdId of the read in this external repository.string
MolecularSequence_Repository_readsetIdExtensions for readsetIdElement
MolecularSequence_RocidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_RocextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RocmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RocscoreInvidual data point representing the GQ (genotype quality) score threshold.integer
MolecularSequence_Roc_scoreExtensions for scoreElement
MolecularSequence_RocnumTPThe number of true positives if the GQ score threshold was set to "score" field value.integer
MolecularSequence_Roc_numTPExtensions for numTPElement
MolecularSequence_RocnumFPThe number of false positives if the GQ score threshold was set to "score" field value.integer
MolecularSequence_Roc_numFPExtensions for numFPElement
MolecularSequence_RocnumFNThe number of false negatives if the GQ score threshold was set to "score" field value.integer
MolecularSequence_Roc_numFNExtensions for numFNElement
MolecularSequence_RocprecisionCalculated precision if the GQ score threshold was set to "score" field value.decimal
MolecularSequence_Roc_precisionExtensions for precisionElement
MolecularSequence_RocsensitivityCalculated sensitivity if the GQ score threshold was set to "score" field value.decimal
MolecularSequence_Roc_sensitivityExtensions for sensitivityElement
MolecularSequence_RocfMeasureCalculated fScore if the GQ score threshold was set to "score" field value.decimal
MolecularSequence_Roc_fMeasureExtensions for fMeasureElement
MolecularSequence_StructureVariantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_StructureVariantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StructureVariantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StructureVariantvariantTypeInformation about chromosome structure variation DNA change type.CodeableConcept
MolecularSequence_StructureVariantexactUsed to indicate if the outer and inner start-end values have the same meaning.boolean
MolecularSequence_StructureVariant_exactExtensions for exactElement
MolecularSequence_StructureVariantlengthLength of the variant chromosome.integer
MolecularSequence_StructureVariant_lengthExtensions for lengthElement
MolecularSequence_StructureVariantouterStructural variant outer.MolecularSequence_Outer
MolecularSequence_StructureVariantinnerStructural variant inner.MolecularSequence_Inner
MolecularSequence_VariantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MolecularSequence_VariantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_VariantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_VariantstartStart 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_startExtensions for startElement
MolecularSequence_VariantendEnd 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_endExtensions for endElement
MolecularSequence_VariantobservedAlleleAn 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_observedAlleleExtensions for observedAlleleElement
MolecularSequence_VariantreferenceAlleleAn 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_referenceAlleleExtensions for referenceAlleleElement
MolecularSequence_VariantcigarExtended 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_cigarExtensions for cigarElement
MolecularSequence_VariantvariantPointerA pointer to an Observation containing variant information.Reference
MoneyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
MoneyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
MoneyvalueNumerical value (with implicit precision).decimal
Money_valueExtensions for valueElement
MoneycurrencyISO 4217 Currency Code.code
Money_currencyExtensions for currencyElement
NamingSystemresourceTypeThis is a NamingSystem resourceNamingSystem
NamingSystemidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
NamingSystemmetaThe metadata about the resource. 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
NamingSystemimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
NamingSystemlanguageThe base language in which the resource is written.code
NamingSystem_languageExtensions for languageElement
NamingSystemtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
NamingSystemcontainedThese 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
NamingSystemextensionMay be 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
NamingSystemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
NamingSystemurlAn absolute URI that is used to identify this naming system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers.uri
NamingSystem_urlExtensions for urlElement
NamingSystemidentifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
NamingSystemversionThe identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.string
NamingSystem_versionExtensions for versionElement
NamingSystemnameA 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_nameExtensions for nameElement
NamingSystemtitleA short, descriptive, user-friendly title for the {{title}}.string
NamingSystem_titleExtensions for titleElement
NamingSystemstatusThe status of this naming system. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
NamingSystem_statusExtensions for statusElement
NamingSystemexperimentalA Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.boolean
NamingSystem_experimentalExtensions for experimentalElement
NamingSystemdateThe 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_dateExtensions for dateElement
NamingSystempublisherThe name of the organization or individual that published the naming system.string
NamingSystem_publisherExtensions for publisherElement
NamingSystemcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
NamingSystemdescriptionA 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_descriptionExtensions for descriptionElement
NamingSystemuseContextThe 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
NamingSystemjurisdictionA legal or geographic region in which the naming system is intended to be used.CodeableConcept
NamingSystempurposeExplanation of why this {{title}} is needed and why it has been designed as it has.markdown
NamingSystem_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
NamingSystemkindIndicates the purpose for the naming system - what kinds of things does it make unique?enum values:
codesystem
identifier
root
NamingSystem_kindExtensions for kindElement
NamingSystemresponsibleThe name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.string
NamingSystem_responsibleExtensions for responsibleElement
NamingSystemtypeCategorizes a naming system for easier search by grouping related naming systems.CodeableConcept
NamingSystemusageProvides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.string
NamingSystem_usageExtensions for usageElement
NamingSystemuniqueIdIndicates how the system may be identified when referenced in electronic exchange.NamingSystem_UniqueId
NamingSystem_UniqueIdidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NamingSystem_UniqueIdextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_UniqueIdmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_UniqueIdtypeIdentifies the unique identifier scheme used for this particular identifier.enum values:
oid
uuid
uri
other
NamingSystem_UniqueId_typeExtensions for typeElement
NamingSystem_UniqueIdvalueThe string that should be sent over the wire to identify the code system or identifier system.string
NamingSystem_UniqueId_valueExtensions for valueElement
NamingSystem_UniqueIdpreferredIndicates whether this identifier is the "preferred" identifier of this type.boolean
NamingSystem_UniqueId_preferredExtensions for preferredElement
NamingSystem_UniqueIdcommentNotes about the past or intended usage of this identifier.string
NamingSystem_UniqueId_commentExtensions for commentElement
NamingSystem_UniqueIdperiodIdentifies 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
NarrativeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NarrativeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NarrativestatusThe 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_statusExtensions for statusElement
NarrativedivThe actual narrative content, a stripped down version of XHTML.xhtml
NutritionIntakeresourceTypeThis is a NutritionIntake resourceNutritionIntake
NutritionIntakeidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
NutritionIntakemetaThe metadata about the resource. 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
NutritionIntakeimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
NutritionIntake_implicitRulesExtensions for implicitRulesElement
NutritionIntakelanguageThe base language in which the resource is written.code
NutritionIntake_languageExtensions for languageElement
NutritionIntaketextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
NutritionIntakecontainedThese 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
NutritionIntakeextensionMay be 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
NutritionIntakemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
NutritionIntakeidentifierIdentifiers associated with this Nutrition Intake that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.Identifier
NutritionIntakeinstantiatesCanonicalInstantiates FHIR protocol or definition.canonical
NutritionIntakeinstantiatesUriInstantiates external protocol or definition.uri
NutritionIntake_instantiatesUriExtensions for instantiatesUriElement
NutritionIntakebasedOnA plan, proposal or order that is fulfilled in whole or in part by this event.Reference
NutritionIntakepartOfA larger event of which this particular event is a component or step.Reference
NutritionIntakestatusA code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.code
NutritionIntake_statusExtensions for statusElement
NutritionIntakestatusReasonCaptures the reason for the current state of the NutritionIntake.CodeableConcept
NutritionIntakecodeType of nutrition intake setting/reporting.CodeableConcept
NutritionIntakesubjectThe person, animal or group who is/was consuming the food or fluid.Reference
NutritionIntakeencounterThe encounter that establishes the context for this NutritionIntake.Reference
NutritionIntakeoccurrenceDateTimeThe interval of time during which it is being asserted that the patient is/was consuming the food or fluid.notDefined
NutritionIntake_occurrenceDateTimeExtensions for occurrenceDateTimeElement
NutritionIntakeoccurrencePeriodThe interval of time during which it is being asserted that the patient is/was consuming the food or fluid.Period
NutritionIntakerecordedThe date when the Nutrition Intake was asserted by the information source.dateTime
NutritionIntake_recordedExtensions for recordedElement
NutritionIntakereportedBooleanThe person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.notDefined
NutritionIntake_reportedBooleanExtensions for reportedBooleanElement
NutritionIntakereportedReferenceThe person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.Reference
NutritionIntakeconsumedItemWhat food or fluid product or item was consumed.NutritionIntake_ConsumedItem
NutritionIntakeingredientLabelTotal nutrient amounts for the whole meal, product, serving, etc.NutritionIntake_IngredientLabel
NutritionIntakeperformerWho performed the intake and how they were involved.NutritionIntake_Performer
NutritionIntakelocationWhere the intake occurred.Reference
NutritionIntakederivedFromAllows linking the NutritionIntake to the underlying NutritionOrder, or to other information, such as AllergyIntolerance, that supports or is used to derive the NutritionIntake.Reference
NutritionIntakereasonA reason, Condition or observation for why the food or fluid is /was consumed.CodeableReference
NutritionIntakenoteProvides extra information about the Nutrition Intake that is not conveyed by the other attributes.Annotation
NutritionIntake_ConsumedItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionIntake_ConsumedItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NutritionIntake_ConsumedItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
NutritionIntake_ConsumedItemtypeIndicates what a category of item that was consumed: eg., food, fluid, enteral, etc.CodeableConcept
NutritionIntake_ConsumedItemnutritionProductIdentifies the food or fluid product that was consumed. This is potentially a link to a resource representing the details of the food product (TBD) or a simple attribute carrying a code that identifies the food from a known list of foods.CodeableReference
NutritionIntake_ConsumedItemscheduleScheduled frequency of consumption.Timing
NutritionIntake_ConsumedItemamountQuantity of the specified food.Quantity
NutritionIntake_ConsumedItemrateRate at which enteral feeding was administered.Quantity
NutritionIntake_ConsumedItemnotConsumedIndicator when a patient is in a setting where it is helpful to know if food was not consumed, such as it was refused, held (as in tube feedings), or otherwise not provided. If a consumption is being recorded from an app, such as MyFitnessPal, this indicator will likely not be used.boolean
NutritionIntake_ConsumedItem_notConsumedExtensions for notConsumedElement
NutritionIntake_ConsumedItemnotConsumedReasonDocument the reason the food or fluid was not consumed, such as refused, held, etc.CodeableConcept
NutritionIntake_IngredientLabelidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionIntake_IngredientLabelextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NutritionIntake_IngredientLabelmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
NutritionIntake_IngredientLabelnutrientTotal nutrient consumed. This could be a macronutrient (protein, fat, carbohydrate), or a vitamin and mineral.CodeableReference
NutritionIntake_IngredientLabelamountTotal amount of nutrient consumed.Quantity
NutritionIntake_PerformeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionIntake_PerformerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NutritionIntake_PerformermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
NutritionIntake_PerformerfunctionType of performer.CodeableConcept
NutritionIntake_PerformeractorWho performed the intake.Reference
NutritionOrderresourceTypeThis is a NutritionOrder resourceNutritionOrder
NutritionOrderidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
NutritionOrdermetaThe metadata about the resource. 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
NutritionOrderimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
NutritionOrderlanguageThe base language in which the resource is written.code
NutritionOrder_languageExtensions for languageElement
NutritionOrdertextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
NutritionOrdercontainedThese 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
NutritionOrderextensionMay be 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
NutritionOrdermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
NutritionOrderidentifierIdentifiers assigned to this order by the order sender or by the order receiver.Identifier
NutritionOrderinstantiatesCanonicalThe 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
NutritionOrderinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
NutritionOrderinstantiatesThe URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.uri
NutritionOrder_instantiatesExtensions for instantiatesElement
NutritionOrderstatusThe workflow status of the nutrition order/request.code
NutritionOrder_statusExtensions for statusElement
NutritionOrderintentIndicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.code
NutritionOrder_intentExtensions for intentElement
NutritionOrderpatientThe person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.Reference
NutritionOrderencounterAn encounter that provides additional information about the healthcare context in which this request is made.Reference
NutritionOrderdateTimeThe date and time that this nutrition order was requested.dateTime
NutritionOrder_dateTimeExtensions for dateTimeElement
NutritionOrderordererThe practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.Reference
NutritionOrderallergyIntoleranceA link to a record of allergies or intolerances which should be included in the nutrition order.Reference
NutritionOrderfoodPreferenceModifierThis 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
NutritionOrderexcludeFoodModifierThis 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
NutritionOrderoralDietDiet given orally in contrast to enteral (tube) feeding.NutritionOrder_OralDiet
NutritionOrdersupplementOral nutritional products given in order to add further nutritional value to the patient's diet.NutritionOrder_Supplement
NutritionOrderenteralFormulaFeeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.NutritionOrder_EnteralFormula
NutritionOrdernoteComments made about the {{title}} by the requester, performer, subject or other participants.Annotation
NutritionOrder_AdministrationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionOrder_AdministrationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AdministrationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AdministrationscheduleThe time period and frequency at which the enteral formula should be delivered to the patient.Timing
NutritionOrder_AdministrationquantityThe volume of formula to provide to the patient per the specified administration schedule.Quantity
NutritionOrder_AdministrationrateQuantityThe rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.Quantity
NutritionOrder_AdministrationrateRatioThe rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.Ratio
NutritionOrder_EnteralFormulaidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionOrder_EnteralFormulaextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EnteralFormulamodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EnteralFormulabaseFormulaTypeThe type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.CodeableConcept
NutritionOrder_EnteralFormulabaseFormulaProductNameThe product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".string
NutritionOrder_EnteralFormula_baseFormulaProductNameExtensions for baseFormulaProductNameElement
NutritionOrder_EnteralFormulaadditiveTypeIndicates 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_EnteralFormulaadditiveProductNameThe product or brand name of the type of modular component to be added to the formula.string
NutritionOrder_EnteralFormula_additiveProductNameExtensions for additiveProductNameElement
NutritionOrder_EnteralFormulacaloricDensityThe 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_EnteralFormularouteofAdministrationThe 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_EnteralFormulaadministrationFormula 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_EnteralFormulamaxVolumeToDeliverThe 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_EnteralFormulaadministrationInstructionFree text formula administration, feeding instructions or additional instructions or information.string
NutritionOrder_EnteralFormula_administrationInstructionExtensions for administrationInstructionElement
NutritionOrder_NutrientidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionOrder_NutrientextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_NutrientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_NutrientmodifierThe nutrient that is being modified such as carbohydrate or sodium.CodeableConcept
NutritionOrder_NutrientamountThe quantity of the specified nutrient to include in diet.Quantity
NutritionOrder_OralDietidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionOrder_OralDietextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OralDietmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OralDiettypeThe kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.CodeableConcept
NutritionOrder_OralDietscheduleThe 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_OralDietnutrientClass that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.NutritionOrder_Nutrient
NutritionOrder_OralDiettextureClass that describes any texture modifications required for the patient to safely consume various types of solid foods.NutritionOrder_Texture
NutritionOrder_OralDietfluidConsistencyTypeThe required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.CodeableConcept
NutritionOrder_OralDietinstructionFree text or additional instructions or information pertaining to the oral diet.string
NutritionOrder_OralDiet_instructionExtensions for instructionElement
NutritionOrder_SupplementidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionOrder_SupplementextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SupplementmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SupplementtypeThe kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.CodeableConcept
NutritionOrder_SupplementproductNameThe product or brand name of the nutritional supplement such as "Acme Protein Shake".string
NutritionOrder_Supplement_productNameExtensions for productNameElement
NutritionOrder_SupplementscheduleThe 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_SupplementquantityThe amount of the nutritional supplement to be given.Quantity
NutritionOrder_SupplementinstructionFree text or additional instructions or information pertaining to the oral supplement.string
NutritionOrder_Supplement_instructionExtensions for instructionElement
NutritionOrder_TextureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionOrder_TextureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TexturemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TexturemodifierAny texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.CodeableConcept
NutritionOrder_TexturefoodTypeThe food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.CodeableConcept
NutritionProductresourceTypeThis is a NutritionProduct resourceNutritionProduct
NutritionProductidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
NutritionProductmetaThe metadata about the resource. 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
NutritionProductimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
NutritionProduct_implicitRulesExtensions for implicitRulesElement
NutritionProductlanguageThe base language in which the resource is written.code
NutritionProduct_languageExtensions for languageElement
NutritionProducttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
NutritionProductcontainedThese 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
NutritionProductextensionMay be 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
NutritionProductmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
NutritionProductstatusThe current state of the product.enum values:
active
inactive
entered-in-error
NutritionProduct_statusExtensions for statusElement
NutritionProductcategoryNutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.CodeableConcept
NutritionProductcodeThe code assigned to the product, for example a manufacturer number or other terminology.CodeableConcept
NutritionProductmanufacturerThe organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.Reference
NutritionProductnutrientThe product's nutritional information expressed by the nutrients.NutritionProduct_Nutrient
NutritionProductingredientIngredients contained in this product.NutritionProduct_Ingredient
NutritionProductknownAllergenAllergens that are known to be a part of this nutrition product.CodeableReference
NutritionProductproductCharacteristicSpecifies descriptive properties of the nutrition product.NutritionProduct_ProductCharacteristic
NutritionProductinstanceConveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.NutritionProduct_Instance
NutritionProductnoteComments made about the product.Annotation
NutritionProduct_IngredientidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionProduct_IngredientextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NutritionProduct_IngredientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
NutritionProduct_IngredientitemThe ingredient contained in the product.CodeableReference
NutritionProduct_IngredientamountThe amount of ingredient that is in the product.Ratio
NutritionProduct_InstanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionProduct_InstanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NutritionProduct_InstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
NutritionProduct_InstancequantityThe amount of items or instances that the resource considers, for instance when referring to 2 identical units together.Quantity
NutritionProduct_InstanceidentifierThe identifier for the physical instance, typically a serial number.Identifier
NutritionProduct_InstancelotNumberThe identification of the batch or lot of the product.string
NutritionProduct_Instance_lotNumberExtensions for lotNumberElement
NutritionProduct_InstanceexpiryThe time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.dateTime
NutritionProduct_Instance_expiryExtensions for expiryElement
NutritionProduct_InstanceuseByThe time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.dateTime
NutritionProduct_Instance_useByExtensions for useByElement
NutritionProduct_NutrientidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionProduct_NutrientextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NutritionProduct_NutrientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
NutritionProduct_NutrientitemThe (relevant) nutrients in the product.CodeableReference
NutritionProduct_NutrientamountThe amount of nutrient expressed in one or more units: X per pack / per serving / per dose.Ratio
NutritionProduct_ProductCharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
NutritionProduct_ProductCharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
NutritionProduct_ProductCharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
NutritionProduct_ProductCharacteristictypeA code specifying which characteristic of the product is being described (for example, colour, shape).CodeableConcept
NutritionProduct_ProductCharacteristicvalueCodeableConceptThe actual characteristic value corresponding to the type.CodeableConcept
NutritionProduct_ProductCharacteristicvalueStringThe actual characteristic value corresponding to the type.notDefined
NutritionProduct_ProductCharacteristic_valueStringExtensions for valueStringElement
NutritionProduct_ProductCharacteristicvalueQuantityThe actual characteristic value corresponding to the type.Quantity
NutritionProduct_ProductCharacteristicvalueBase64BinaryThe actual characteristic value corresponding to the type.notDefined
NutritionProduct_ProductCharacteristic_valueBase64BinaryExtensions for valueBase64BinaryElement
NutritionProduct_ProductCharacteristicvalueAttachmentThe actual characteristic value corresponding to the type.Attachment
NutritionProduct_ProductCharacteristicvalueBooleanThe actual characteristic value corresponding to the type.notDefined
NutritionProduct_ProductCharacteristic_valueBooleanExtensions for valueBooleanElement
ObservationresourceTypeThis is a Observation resourceObservation
ObservationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ObservationmetaThe metadata about the resource. 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
ObservationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ObservationlanguageThe base language in which the resource is written.code
Observation_languageExtensions for languageElement
ObservationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ObservationcontainedThese 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
ObservationextensionMay be 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
ObservationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ObservationidentifierA unique identifier assigned to this observation.Identifier
ObservationbasedOnA 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
ObservationpartOfA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.Reference
ObservationstatusThe status of the result value.enum values:
registered
preliminary
final
amended
corrected
cancelled
entered-in-error
unknown
Observation_statusExtensions for statusElement
ObservationcategoryA code that classifies the general type of observation being made.CodeableConcept
ObservationcodeDescribes what was observed. Sometimes this is called the observation "name".CodeableConcept
ObservationsubjectThe 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
ObservationfocusThe 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
ObservationencounterThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.Reference
ObservationeffectiveDateTimeThe 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_effectiveDateTimeExtensions for effectiveDateTimeElement
ObservationeffectivePeriodThe 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
ObservationeffectiveTimingThe 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
ObservationeffectiveInstantThe 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_effectiveInstantExtensions for effectiveInstantElement
ObservationissuedThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.instant
Observation_issuedExtensions for issuedElement
ObservationperformerWho was responsible for asserting the observed value as "true".Reference
ObservationvalueQuantityThe information determined as a result of making the observation, if the information has a simple value.Quantity
ObservationvalueCodeableConceptThe information determined as a result of making the observation, if the information has a simple value.CodeableConcept
ObservationvalueStringThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_valueStringExtensions for valueStringElement
ObservationvalueBooleanThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_valueBooleanExtensions for valueBooleanElement
ObservationvalueIntegerThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_valueIntegerExtensions for valueIntegerElement
ObservationvalueRangeThe information determined as a result of making the observation, if the information has a simple value.Range
ObservationvalueRatioThe information determined as a result of making the observation, if the information has a simple value.Ratio
ObservationvalueSampledDataThe information determined as a result of making the observation, if the information has a simple value.SampledData
ObservationvalueTimeThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_valueTimeExtensions for valueTimeElement
ObservationvalueDateTimeThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_valueDateTimeExtensions for valueDateTimeElement
ObservationvaluePeriodThe information determined as a result of making the observation, if the information has a simple value.Period
ObservationvalueAttachmentThe information determined as a result of making the observation, if the information has a simple value.Attachment
ObservationdataAbsentReasonProvides a reason why the expected value in the element Observation.value[x] is missing.CodeableConcept
ObservationinterpretationA categorical assessment of an observation value. For example, high, low, normal.CodeableConcept
ObservationnoteComments about the observation or the results.Annotation
ObservationbodySiteIndicates the site on the subject's body where the observation was made (i.e. the target site).CodeableConcept
ObservationmethodIndicates the mechanism used to perform the observation.CodeableConcept
ObservationspecimenThe specimen that was used when this observation was made.Reference
ObservationdeviceThe device used to generate the observation data.Reference
ObservationreferenceRangeGuidance 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
ObservationhasMemberThis 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
ObservationderivedFromThe 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
ObservationcomponentSome 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
ObservationDefinitionresourceTypeThis is a ObservationDefinition resourceObservationDefinition
ObservationDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ObservationDefinitionmetaThe metadata about the resource. 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
ObservationDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ObservationDefinitionlanguageThe base language in which the resource is written.code
ObservationDefinition_languageExtensions for languageElement
ObservationDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ObservationDefinitioncontainedThese 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
ObservationDefinitionextensionMay be 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
ObservationDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ObservationDefinitionurlAn absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.uri
ObservationDefinition_urlExtensions for urlElement
ObservationDefinitionidentifierBusiness identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.Identifier
ObservationDefinitionversionThe identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.string
ObservationDefinition_versionExtensions for versionElement
ObservationDefinitiontitleA short, descriptive, user-friendly title for the ObservationDefinition.string
ObservationDefinition_titleExtensions for titleElement
ObservationDefinitionderivedFromCanonicalThe canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.canonical
ObservationDefinitionderivedFromUriThe URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.uri
ObservationDefinition_derivedFromUriExtensions for derivedFromUriElement
ObservationDefinitionstatusThe current state of the ObservationDefinition.code
ObservationDefinition_statusExtensions for statusElement
ObservationDefinitionexperimentalA flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.boolean
ObservationDefinition_experimentalExtensions for experimentalElement
ObservationDefinitionsubjectCodeableConceptA code or group definition that describes the intended subject of Observation instances conforming to this ObservationDefinition.CodeableConcept
ObservationDefinitionsubjectReferenceA code or group definition that describes the intended subject of Observation instances conforming to this ObservationDefinition.Reference
ObservationDefinitiondateFor draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.dateTime
ObservationDefinition_dateExtensions for dateElement
ObservationDefinitionpublisherHelps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.Reference
ObservationDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ObservationDefinitiondescriptionA free text natural language description of the ObservationDefinition from the consumer's perspective.markdown
ObservationDefinition_descriptionExtensions for descriptionElement
ObservationDefinitionuseContextThe content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of observation definitions.UsageContext
ObservationDefinitionjurisdictionA jurisdiction in which the ObservationDefinition is intended to be used.CodeableConcept
ObservationDefinitionpurposeExplains why this ObservationDefinition is needed and why it has been designed as it has.markdown
ObservationDefinition_purposeExtensions for purposeElement
copyrightCopyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.markdown
_copyrightExtensions for copyrightElement
ObservationDefinitionapprovalDateThe date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
ObservationDefinition_approvalDateExtensions for approvalDateElement
ObservationDefinitionlastReviewDateThe date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.date
ObservationDefinition_lastReviewDateExtensions for lastReviewDateElement
ObservationDefinitioneffectivePeriodThe period during which the ObservationDefinition content was or is planned to be effective.Period
ObservationDefinitionperformerTypeThe type of individual/organization/device that is expected to act upon instances of this definition.CodeableConcept
ObservationDefinitioncategoryA code that classifies the general type of observation.CodeableConcept
ObservationDefinitioncodeDescribes what will be observed. Sometimes this is called the observation "name".CodeableConcept
ObservationDefinitionpermittedDataTypeThe 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_permittedDataTypeExtensions for permittedDataTypeElement
ObservationDefinitionmultipleResultsAllowedMultiple results allowed for observations conforming to this ObservationDefinition.boolean
ObservationDefinition_multipleResultsAllowedExtensions for multipleResultsAllowedElement
ObservationDefinitionbodySiteThe site on the subject's body where the observation is to be made.CodeableConcept
ObservationDefinitionmethodThe method or technique used to perform the observation.CodeableConcept
ObservationDefinitionspecimenThe kind of specimen that this type of observation is produced on.Reference
ObservationDefinitiondeviceThe measurement device used to produce observations of this type.Reference
ObservationDefinitionpreferredReportNameThe preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.string
ObservationDefinition_preferredReportNameExtensions for preferredReportNameElement
ObservationDefinitionquantitativeDetailsCharacteristics for quantitative results of this observation.ObservationDefinition_QuantitativeDetails
ObservationDefinitionqualifiedIntervalMultiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.ObservationDefinition_QualifiedInterval
ObservationDefinitionvalidCodedValueSetThe set of valid coded results for the observations conforming to this ObservationDefinition.Reference
ObservationDefinitionnormalCodedValueSetThe set of normal coded results for the observations conforming to this ObservationDefinition.Reference
ObservationDefinitionabnormalCodedValueSetThe set of abnormal coded results for the observation conforming to this ObservationDefinition.Reference
ObservationDefinitioncriticalCodedValueSetThe set of critical coded results for the observation conforming to this ObservationDefinition.Reference
ObservationDefinitionhasMemberThis ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.Reference
ObservationDefinitioncomponentSome observations have multiple component observations, expressed as separate code value pairs.ObservationDefinition_Component
ObservationDefinition_ComponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ObservationDefinition_ComponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ComponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ComponentcodeDescribes what will be observed.CodeableConcept
ObservationDefinition_ComponentpermittedDataTypeThe data types allowed for the value element of the instance of this component observations.enum values:
Quantity
CodeableConcept
string
boolean
integer
Range
Ratio
SampledData
time
dateTime
Period
ObservationDefinition_Component_permittedDataTypeExtensions for permittedDataTypeElement
ObservationDefinition_ComponentquantitativeDetailsCharacteristics for quantitative results of this observation.ObservationDefinition_QuantitativeDetails
ObservationDefinition_ComponentqualifiedIntervalMultiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.ObservationDefinition_QualifiedInterval
ObservationDefinition_QualifiedIntervalidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ObservationDefinition_QualifiedIntervalextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_QualifiedIntervalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_QualifiedIntervalcategoryThe category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.enum values:
reference
critical
absolute
ObservationDefinition_QualifiedInterval_categoryExtensions for categoryElement
ObservationDefinition_QualifiedIntervalrangeThe low and high values determining the interval. There may be only one of the two.Range
ObservationDefinition_QualifiedIntervalcontextCodes to indicate the health context the range applies to. For example, the normal or therapeutic range.CodeableConcept
ObservationDefinition_QualifiedIntervalappliesToCodes to indicate the target population this reference range applies to.CodeableConcept
ObservationDefinition_QualifiedIntervalgenderSex of the population the range applies to.enum values:
male
female
other
unknown
ObservationDefinition_QualifiedInterval_genderExtensions for genderElement
ObservationDefinition_QualifiedIntervalageThe 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_QualifiedIntervalgestationalAgeThe gestational age to which this reference range is applicable, in the context of pregnancy.Range
ObservationDefinition_QualifiedIntervalconditionText based condition for which the reference range is valid.string
ObservationDefinition_QualifiedInterval_conditionExtensions for conditionElement
ObservationDefinition_QuantitativeDetailsidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ObservationDefinition_QuantitativeDetailsextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_QuantitativeDetailsmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_QuantitativeDetailscustomaryUnitCustomary unit used to report quantitative results of observations conforming to this ObservationDefinition.CodeableConcept
ObservationDefinition_QuantitativeDetailsunitSI unit used to report quantitative results of observations conforming to this ObservationDefinition.CodeableConcept
ObservationDefinition_QuantitativeDetailsconversionFactorFactor for converting value expressed with SI unit to value expressed with customary unit.decimal
ObservationDefinition_QuantitativeDetails_conversionFactorExtensions for conversionFactorElement
ObservationDefinition_QuantitativeDetailsdecimalPrecisionNumber of digits after decimal separator when the results of such observations are of type Quantity.integer
ObservationDefinition_QuantitativeDetails_decimalPrecisionExtensions for decimalPrecisionElement
Observation_ComponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Observation_ComponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ComponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ComponentcodeDescribes what was observed. Sometimes this is called the observation "code".CodeableConcept
Observation_ComponentvalueQuantityThe information determined as a result of making the observation, if the information has a simple value.Quantity
Observation_ComponentvalueCodeableConceptThe information determined as a result of making the observation, if the information has a simple value.CodeableConcept
Observation_ComponentvalueStringThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_Component_valueStringExtensions for valueStringElement
Observation_ComponentvalueBooleanThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_Component_valueBooleanExtensions for valueBooleanElement
Observation_ComponentvalueIntegerThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_Component_valueIntegerExtensions for valueIntegerElement
Observation_ComponentvalueRangeThe information determined as a result of making the observation, if the information has a simple value.Range
Observation_ComponentvalueRatioThe information determined as a result of making the observation, if the information has a simple value.Ratio
Observation_ComponentvalueSampledDataThe information determined as a result of making the observation, if the information has a simple value.SampledData
Observation_ComponentvalueTimeThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_Component_valueTimeExtensions for valueTimeElement
Observation_ComponentvalueDateTimeThe information determined as a result of making the observation, if the information has a simple value.notDefined
Observation_Component_valueDateTimeExtensions for valueDateTimeElement
Observation_ComponentvaluePeriodThe information determined as a result of making the observation, if the information has a simple value.Period
Observation_ComponentvalueAttachmentThe information determined as a result of making the observation, if the information has a simple value.Attachment
Observation_ComponentdataAbsentReasonProvides a reason why the expected value in the element Observation.component.value[x] is missing.CodeableConcept
Observation_ComponentinterpretationA categorical assessment of an observation value. For example, high, low, normal.CodeableConcept
Observation_ComponentreferenceRangeGuidance on how to interpret the value by comparison to a normal or recommended range.Observation_ReferenceRange
Observation_ReferenceRangeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Observation_ReferenceRangeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ReferenceRangemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ReferenceRangelowThe 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_ReferenceRangehighThe 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_ReferenceRangetypeCodes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.CodeableConcept
Observation_ReferenceRangeappliesToCodes 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_ReferenceRangeageThe 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_ReferenceRangetextText 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_textExtensions for textElement
OperationDefinitionresourceTypeThis is a OperationDefinition resourceOperationDefinition
OperationDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
OperationDefinitionmetaThe metadata about the resource. 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
OperationDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
OperationDefinitionlanguageThe base language in which the resource is written.code
OperationDefinition_languageExtensions for languageElement
OperationDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
OperationDefinitioncontainedThese 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
OperationDefinitionextensionMay be 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
OperationDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
OperationDefinitionurlAn 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_urlExtensions for urlElement
OperationDefinitionidentifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
OperationDefinitionversionThe 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_versionExtensions for versionElement
OperationDefinitionnameA 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_nameExtensions for nameElement
OperationDefinitiontitleA short, descriptive, user-friendly title for the operation definition.string
OperationDefinition_titleExtensions for titleElement
OperationDefinitionstatusThe status of this operation definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
OperationDefinition_statusExtensions for statusElement
OperationDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
OperationDefinitiondateThe 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_dateExtensions for dateElement
OperationDefinitionpublisherThe name of the organization or individual that published the operation definition.string
OperationDefinition_publisherExtensions for publisherElement
OperationDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
OperationDefinitiondescriptionA free text natural language description of the operation definition from a consumer's perspective.markdown
OperationDefinition_descriptionExtensions for descriptionElement
OperationDefinitionuseContextThe 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
OperationDefinitionjurisdictionA legal or geographic region in which the operation definition is intended to be used.CodeableConcept
OperationDefinitionpurposeExplanation of why this operation definition is needed and why it has been designed as it has.markdown
OperationDefinition_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
OperationDefinitionkindWhether this is an operation or a named query.enum values:
operation
query
OperationDefinition_kindExtensions for kindElement
OperationDefinitionaffectsStateWhether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.boolean
OperationDefinition_affectsStateExtensions for affectsStateElement
OperationDefinitioncodeThe name used to invoke the operation.code
OperationDefinition_codeExtensions for codeElement
OperationDefinitioncommentAdditional information about how to use this operation or named query.markdown
OperationDefinition_commentExtensions for commentElement
OperationDefinitionbaseIndicates that this operation definition is a constraining profile on the base.canonical
OperationDefinitionresourceThe types on which this operation can be executed.code
OperationDefinition_resourceExtensions for resourceElement
OperationDefinitionsystemIndicates 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_systemExtensions for systemElement
OperationDefinitiontypeIndicates 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_typeExtensions for typeElement
OperationDefinitioninstanceIndicates whether this operation can be invoked on a particular instance of one of the given types.boolean
OperationDefinition_instanceExtensions for instanceElement
OperationDefinitioninputProfileAdditional 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
OperationDefinitionoutputProfileAdditional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.canonical
OperationDefinitionparameterThe parameters for the operation/query.OperationDefinition_Parameter
OperationDefinitionoverloadDefines 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_BindingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
OperationDefinition_BindingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_BindingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_BindingstrengthIndicates 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_strengthExtensions for strengthElement
OperationDefinition_BindingvalueSetPoints to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.canonical
OperationDefinition_OverloadidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
OperationDefinition_OverloadextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OverloadmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OverloadparameterNameName of parameter to include in overload.string
OperationDefinition_Overload_parameterNameExtensions for parameterNameElement
OperationDefinition_OverloadcommentComments to go on overload.string
OperationDefinition_Overload_commentExtensions for commentElement
OperationDefinition_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
OperationDefinition_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParameternameThe name of used to identify the parameter.code
OperationDefinition_Parameter_nameExtensions for nameElement
OperationDefinition_ParameteruseWhether this is an input or an output parameter.enum values:
in
out
OperationDefinition_Parameter_useExtensions for useElement
OperationDefinition_ParameterminThe minimum number of times this parameter SHALL appear in the request or response.integer
OperationDefinition_Parameter_minExtensions for minElement
OperationDefinition_ParametermaxThe maximum number of times this element is permitted to appear in the request or response.string
OperationDefinition_Parameter_maxExtensions for maxElement
OperationDefinition_ParameterdocumentationDescribes the meaning or use of this parameter.string
OperationDefinition_Parameter_documentationExtensions for documentationElement
OperationDefinition_ParametertypeThe type for this parameter.code
OperationDefinition_Parameter_typeExtensions for typeElement
OperationDefinition_ParametertargetProfileUsed 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_ParametersearchTypeHow 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_searchTypeExtensions for searchTypeElement
OperationDefinition_ParameterbindingBinds to a value set if this parameter is coded (code, Coding, CodeableConcept).OperationDefinition_Binding
OperationDefinition_ParameterreferencedFromIdentifies other resource parameters within the operation invocation that are expected to resolve to this resource.OperationDefinition_ReferencedFrom
OperationDefinition_ParameterpartThe parts of a nested Parameter.OperationDefinition_Parameter
OperationDefinition_ReferencedFromidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
OperationDefinition_ReferencedFromextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ReferencedFrommodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ReferencedFromsourceThe 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_sourceExtensions for sourceElement
OperationDefinition_ReferencedFromsourceIdThe id of the element in the referencing resource that is expected to resolve to this resource.string
OperationDefinition_ReferencedFrom_sourceIdExtensions for sourceIdElement
OperationOutcomeresourceTypeThis is a OperationOutcome resourceOperationOutcome
OperationOutcomeidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
OperationOutcomemetaThe metadata about the resource. 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
OperationOutcomeimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
OperationOutcomelanguageThe base language in which the resource is written.code
OperationOutcome_languageExtensions for languageElement
OperationOutcometextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
OperationOutcomecontainedThese 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
OperationOutcomeextensionMay be 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
OperationOutcomemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
OperationOutcomeissueAn error, warning, or information message that results from a system action.OperationOutcome_Issue
OperationOutcome_IssueidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
OperationOutcome_IssueextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_IssuemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_IssueseverityIndicates whether the issue indicates a variation from successful processing.enum values:
fatal
error
warning
information
OperationOutcome_Issue_severityExtensions for severityElement
OperationOutcome_IssuecodeDescribes 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_codeExtensions for codeElement
OperationOutcome_IssuedetailsAdditional details about the error. This may be a text description of the error or a system code that identifies the error.CodeableConcept
OperationOutcome_IssuediagnosticsAdditional diagnostic information about the issue.string
OperationOutcome_Issue_diagnosticsExtensions for diagnosticsElement
OperationOutcome_IssuelocationThis 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_locationExtensions for locationElement
OperationOutcome_IssueexpressionA [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_expressionExtensions for expressionElement
OrderedDistributionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
OrderedDistributionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
OrderedDistributionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
OrderedDistributiondescriptionA description of the content and value of the statistic.string
OrderedDistribution_descriptionExtensions for descriptionElement
OrderedDistributionnoteFootnotes and/or explanatory notes.Annotation
OrderedDistributionnumberOfIntervalsNumber of intervals in an array, eg 4 for quartiles.integer
OrderedDistribution_numberOfIntervalsExtensions for numberOfIntervalsElement
OrderedDistributionbottomOfFirstIntervalBottom of first interval.Quantity
OrderedDistributionintervalInterval.OrderedDistribution_Interval
OrderedDistributiontopOfIntervalSingular value of the statistic at the upper bound of the interval.Quantity
OrderedDistribution_IntervalidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
OrderedDistribution_IntervalextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
OrderedDistribution_IntervalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
OrderedDistribution_IntervalrankOrderRelative order of interval.integer
OrderedDistribution_Interval_rankOrderExtensions for rankOrderElement
OrderedDistribution_IntervalintervalStatisticValues and parameters for a single statistic related to the interval.Statistic
OrganizationresourceTypeThis is a Organization resourceOrganization
OrganizationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
OrganizationmetaThe metadata about the resource. 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
OrganizationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
OrganizationlanguageThe base language in which the resource is written.code
Organization_languageExtensions for languageElement
OrganizationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
OrganizationcontainedThese 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
OrganizationextensionMay be 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
OrganizationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
OrganizationidentifierIdentifier for the organization that is used to identify the organization across multiple disparate systems.Identifier
OrganizationactiveWhether the organization's record is still in active use.boolean
Organization_activeExtensions for activeElement
OrganizationtypeThe kind(s) of organization that this is.CodeableConcept
OrganizationnameA name associated with the organization.string
Organization_nameExtensions for nameElement
OrganizationaliasA list of alternate names that the organization is known as, or was known as in the past.string
Organization_aliasExtensions for aliasElement
OrganizationtelecomA contact detail for the organization.ContactPoint
OrganizationaddressAn address for the organization.Address
OrganizationpartOfThe organization of which this organization forms a part.Reference
OrganizationcontactContact for the organization for a certain purpose.Organization_Contact
OrganizationendpointTechnical endpoints providing access to services operated for the organization.Reference
OrganizationAffiliationresourceTypeThis is a OrganizationAffiliation resourceOrganizationAffiliation
OrganizationAffiliationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
OrganizationAffiliationmetaThe metadata about the resource. 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
OrganizationAffiliationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
OrganizationAffiliationlanguageThe base language in which the resource is written.code
OrganizationAffiliation_languageExtensions for languageElement
OrganizationAffiliationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
OrganizationAffiliationcontainedThese 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
OrganizationAffiliationextensionMay be 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
OrganizationAffiliationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
OrganizationAffiliationidentifierBusiness identifiers that are specific to this role.Identifier
OrganizationAffiliationactiveWhether this organization affiliation record is in active use.boolean
OrganizationAffiliation_activeExtensions for activeElement
OrganizationAffiliationperiodThe period during which the participatingOrganization is affiliated with the primary organization.Period
OrganizationAffiliationorganizationOrganization where the role is available (primary organization/has members).Reference
OrganizationAffiliationparticipatingOrganizationThe 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
OrganizationAffiliationnetworkHealth insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).Reference
OrganizationAffiliationcodeDefinition of the role the participatingOrganization plays in the association.CodeableConcept
OrganizationAffiliationspecialtySpecific specialty of the participatingOrganization in the context of the role.CodeableConcept
OrganizationAffiliationlocationThe location(s) at which the role occurs.Reference
OrganizationAffiliationhealthcareServiceHealthcare services provided through the role.Reference
OrganizationAffiliationtelecomContact details at the participatingOrganization relevant to this Affiliation.ContactPoint
OrganizationAffiliationendpointTechnical endpoints providing access to services operated for this role.Reference
Organization_ContactidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Organization_ContactextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContactmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContactpurposeIndicates a purpose for which the contact can be reached.CodeableConcept
Organization_ContactnameA name associated with the contact.HumanName
Organization_ContacttelecomA contact detail (e.g. a telephone number or an email address) by which the party may be contacted.ContactPoint
Organization_ContactaddressVisiting or postal addresses for the contact.Address
PackagedProductDefinitionresourceTypeThis is a PackagedProductDefinition resourcePackagedProductDefinition
PackagedProductDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PackagedProductDefinitionmetaThe metadata about the resource. 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
PackagedProductDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
PackagedProductDefinition_implicitRulesExtensions for implicitRulesElement
PackagedProductDefinitionlanguageThe base language in which the resource is written.code
PackagedProductDefinition_languageExtensions for languageElement
PackagedProductDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PackagedProductDefinitioncontainedThese 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
PackagedProductDefinitionextensionMay be 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
PackagedProductDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PackagedProductDefinitionidentifierUnique identifier.Identifier
PackagedProductDefinitionnameA name for this product pack. Typically what it would be listed as in a drug formulary.string
PackagedProductDefinition_nameExtensions for nameElement
PackagedProductDefinitionsubjectThe product that this is a pack for.Reference
PackagedProductDefinitionstatusThe status within the lifecycle of this product. A high level status, this is not intended to duplicate details carried elswhere such as legal status, or authorization or marketing status.CodeableConcept
PackagedProductDefinitionstatusDateThe date at which the given status became applicable.dateTime
PackagedProductDefinition_statusDateExtensions for statusDateElement
PackagedProductDefinitiondescriptionTextual description. Note that this is not the name of the product.markdown
PackagedProductDefinition_descriptionExtensions for descriptionElement
PackagedProductDefinitionlegalStatusOfSupplyThe legal status of supply of the medicinal product as classified by the regulator.CodeableConcept
PackagedProductDefinitionmarketingStatusMarketing information.MarketingStatus
PackagedProductDefinitioncharacteristicAllows the key product features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".CodeableConcept
PackagedProductDefinitioncopackagedIndicatorStates whether a drug product is supplied with another item such as a diluent or adjuvant.boolean
PackagedProductDefinition_copackagedIndicatorExtensions for copackagedIndicatorElement
PackagedProductDefinitionmarketingAuthorizationManufacturer of this Package Item.Reference
PackagedProductDefinitionmanufacturerManufacturer of this Package Item.Reference
PackagedProductDefinitionbatchIdentifierBatch numbering.PackagedProductDefinition_BatchIdentifier
PackagedProductDefinitionpackageA packaging item, as a contained for medicine, possibly with other packaging items within.PackagedProductDefinition_Package
PackagedProductDefinition_BatchIdentifieridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PackagedProductDefinition_BatchIdentifierextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
PackagedProductDefinition_BatchIdentifiermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
PackagedProductDefinition_BatchIdentifierouterPackagingA number appearing on the outer packaging of a specific batch.Identifier
PackagedProductDefinition_BatchIdentifierimmediatePackagingA number appearing on the immediate packaging (and not the outer packaging).Identifier
PackagedProductDefinition_ContainedItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PackagedProductDefinition_ContainedItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
PackagedProductDefinition_ContainedItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
PackagedProductDefinition_ContainedItemitemThe manufactured item or device as contained in the packaged medicinal product.Reference
PackagedProductDefinition_ContainedItemamountQuantityThe number of this type of item within this packaging.Quantity
PackagedProductDefinition_ContainedItemamountIntegerThe number of this type of item within this packaging.notDefined
PackagedProductDefinition_ContainedItem_amountIntegerExtensions for amountIntegerElement
PackagedProductDefinition_PackageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PackagedProductDefinition_PackageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
PackagedProductDefinition_PackagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
PackagedProductDefinition_PackageidentifierIncluding possibly Data Carrier Identifier.Identifier
PackagedProductDefinition_PackagetypeThe physical type of the container of the medicine.CodeableConcept
PackagedProductDefinition_PackagequantityThe quantity of this package in the medicinal product, at the current level of packaging. If specified, the outermost level is always 1.integer
PackagedProductDefinition_Package_quantityExtensions for quantityElement
PackagedProductDefinition_PackagematerialMaterial type of the package item.CodeableConcept
PackagedProductDefinition_PackagealternateMaterialA possible alternate material for the packaging.CodeableConcept
PackagedProductDefinition_PackageshelfLifeStorageShelf Life and storage information.ProductShelfLife
PackagedProductDefinition_PackagemanufacturerManufacturer of this Package Item.Reference
PackagedProductDefinition_PackagepropertyGeneral characteristics of this item.PackagedProductDefinition_Property
PackagedProductDefinition_PackagecontainedItemThe item(s) within the packaging.PackagedProductDefinition_ContainedItem
PackagedProductDefinition_PackagepackageAllows containers within containers.PackagedProductDefinition_Package
PackagedProductDefinition_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PackagedProductDefinition_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
PackagedProductDefinition_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
PackagedProductDefinition_PropertytypeA code expressing the type of characteristic.CodeableConcept
PackagedProductDefinition_PropertyvalueCodeableConceptA value for the characteristic.CodeableConcept
PackagedProductDefinition_PropertyvalueQuantityA value for the characteristic.Quantity
PackagedProductDefinition_PropertyvalueDateA value for the characteristic.notDefined
PackagedProductDefinition_Property_valueDateExtensions for valueDateElement
PackagedProductDefinition_PropertyvalueBooleanA value for the characteristic.notDefined
PackagedProductDefinition_Property_valueBooleanExtensions for valueBooleanElement
PackagedProductDefinition_PropertyvalueAttachmentA value for the characteristic.Attachment
ParameterDefinitionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ParameterDefinitionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ParameterDefinitionnameThe name of the parameter used to allow access to the value of the parameter in evaluation contexts.code
ParameterDefinition_nameExtensions for nameElement
ParameterDefinitionuseWhether the parameter is input or output for the module.code
ParameterDefinition_useExtensions for useElement
ParameterDefinitionminThe minimum number of times this parameter SHALL appear in the request or response.integer
ParameterDefinition_minExtensions for minElement
ParameterDefinitionmaxThe maximum number of times this element is permitted to appear in the request or response.string
ParameterDefinition_maxExtensions for maxElement
ParameterDefinitiondocumentationA brief discussion of what the parameter is for and how it is used by the module.string
ParameterDefinition_documentationExtensions for documentationElement
ParameterDefinitiontypeThe type of the parameter.code
ParameterDefinition_typeExtensions for typeElement
ParameterDefinitionprofileIf specified, this indicates a profile that the input data must conform to, or that the output data will conform to.canonical
ParametersresourceTypeThis is a Parameters resourceParameters
ParametersidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ParametersmetaThe metadata about the resource. 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
ParametersimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ParameterslanguageThe base language in which the resource is written.code
Parameters_languageExtensions for languageElement
ParametersparameterA parameter passed to or received from the operation.Parameters_Parameter
Parameters_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Parameters_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParameternameThe name of the parameter (reference to the operation definition).string
Parameters_Parameter_nameExtensions for nameElement
Parameters_ParametervalueBase64BinaryIf the parameter is a data type.notDefined
Parameters_Parameter_valueBase64BinaryExtensions for valueBase64BinaryElement
Parameters_ParametervalueBooleanIf the parameter is a data type.notDefined
Parameters_Parameter_valueBooleanExtensions for valueBooleanElement
Parameters_ParametervalueCanonicalIf the parameter is a data type.notDefined
Parameters_Parameter_valueCanonicalExtensions for valueCanonicalElement
Parameters_ParametervalueCodeIf the parameter is a data type.notDefined
Parameters_Parameter_valueCodeExtensions for valueCodeElement
Parameters_ParametervalueDateIf the parameter is a data type.notDefined
Parameters_Parameter_valueDateExtensions for valueDateElement
Parameters_ParametervalueDateTimeIf the parameter is a data type.notDefined
Parameters_Parameter_valueDateTimeExtensions for valueDateTimeElement
Parameters_ParametervalueDecimalIf the parameter is a data type.notDefined
Parameters_Parameter_valueDecimalExtensions for valueDecimalElement
Parameters_ParametervalueIdIf the parameter is a data type.notDefined
Parameters_Parameter_valueIdExtensions for valueIdElement
Parameters_ParametervalueInstantIf the parameter is a data type.notDefined
Parameters_Parameter_valueInstantExtensions for valueInstantElement
Parameters_ParametervalueIntegerIf the parameter is a data type.notDefined
Parameters_Parameter_valueIntegerExtensions for valueIntegerElement
Parameters_ParametervalueInteger64If the parameter is a data type.notDefined
Parameters_Parameter_valueInteger64Extensions for valueInteger64Element
Parameters_ParametervalueMarkdownIf the parameter is a data type.notDefined
Parameters_Parameter_valueMarkdownExtensions for valueMarkdownElement
Parameters_ParametervalueOidIf the parameter is a data type.notDefined
Parameters_Parameter_valueOidExtensions for valueOidElement
Parameters_ParametervaluePositiveIntIf the parameter is a data type.notDefined
Parameters_Parameter_valuePositiveIntExtensions for valuePositiveIntElement
Parameters_ParametervalueStringIf the parameter is a data type.notDefined
Parameters_Parameter_valueStringExtensions for valueStringElement
Parameters_ParametervalueTimeIf the parameter is a data type.notDefined
Parameters_Parameter_valueTimeExtensions for valueTimeElement
Parameters_ParametervalueUnsignedIntIf the parameter is a data type.notDefined
Parameters_Parameter_valueUnsignedIntExtensions for valueUnsignedIntElement
Parameters_ParametervalueUriIf the parameter is a data type.notDefined
Parameters_Parameter_valueUriExtensions for valueUriElement
Parameters_ParametervalueUrlIf the parameter is a data type.notDefined
Parameters_Parameter_valueUrlExtensions for valueUrlElement
Parameters_ParametervalueUuidIf the parameter is a data type.notDefined
Parameters_Parameter_valueUuidExtensions for valueUuidElement
Parameters_ParametervalueAddressIf the parameter is a data type.Address
Parameters_ParametervalueAgeIf the parameter is a data type.Age
Parameters_ParametervalueAnnotationIf the parameter is a data type.Annotation
Parameters_ParametervalueAttachmentIf the parameter is a data type.Attachment
Parameters_ParametervalueCodeableConceptIf the parameter is a data type.CodeableConcept
Parameters_ParametervalueCodingIf the parameter is a data type.Coding
Parameters_ParametervalueContactPointIf the parameter is a data type.ContactPoint
Parameters_ParametervalueCountIf the parameter is a data type.Count
Parameters_ParametervalueDistanceIf the parameter is a data type.Distance
Parameters_ParametervalueDurationIf the parameter is a data type.Duration
Parameters_ParametervalueHumanNameIf the parameter is a data type.HumanName
Parameters_ParametervalueIdentifierIf the parameter is a data type.Identifier
Parameters_ParametervalueMoneyIf the parameter is a data type.Money
Parameters_ParametervaluePeriodIf the parameter is a data type.Period
Parameters_ParametervalueQuantityIf the parameter is a data type.Quantity
Parameters_ParametervalueRangeIf the parameter is a data type.Range
Parameters_ParametervalueRatioIf the parameter is a data type.Ratio
Parameters_ParametervalueReferenceIf the parameter is a data type.Reference
Parameters_ParametervalueSampledDataIf the parameter is a data type.SampledData
Parameters_ParametervalueSignatureIf the parameter is a data type.Signature
Parameters_ParametervalueTimingIf the parameter is a data type.Timing
Parameters_ParametervalueContactDetailIf the parameter is a data type.ContactDetail
Parameters_ParametervalueContributorIf the parameter is a data type.Contributor
Parameters_ParametervalueDataRequirementIf the parameter is a data type.DataRequirement
Parameters_ParametervalueExpressionIf the parameter is a data type.Expression
Parameters_ParametervalueParameterDefinitionIf the parameter is a data type.ParameterDefinition
Parameters_ParametervalueRelatedArtifactIf the parameter is a data type.RelatedArtifact
Parameters_ParametervalueTriggerDefinitionIf the parameter is a data type.TriggerDefinition
Parameters_ParametervalueUsageContextIf the parameter is a data type.UsageContext
Parameters_ParametervalueDosageIf the parameter is a data type.Dosage
Parameters_ParametervalueMetaIf the parameter is a data type.Meta
Parameters_ParameterresourceIf the parameter is a whole resource.ResourceList
Parameters_ParameterpartA named part of a multi-part parameter.Parameters_Parameter
PatientresourceTypeThis is a Patient resourcePatient
PatientidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PatientmetaThe metadata about the resource. 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
PatientimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
PatientlanguageThe base language in which the resource is written.code
Patient_languageExtensions for languageElement
PatienttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PatientcontainedThese 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
PatientextensionMay be 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
PatientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PatientidentifierAn identifier for this patient.Identifier
PatientactiveWhether 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_activeExtensions for activeElement
PatientnameA name associated with the individual.HumanName
PatienttelecomA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.ContactPoint
PatientgenderAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.enum values:
male
female
other
unknown
Patient_genderExtensions for genderElement
PatientbirthDateThe date of birth for the individual.date
Patient_birthDateExtensions for birthDateElement
PatientdeceasedBooleanIndicates if the individual is deceased or not.notDefined
Patient_deceasedBooleanExtensions for deceasedBooleanElement
PatientdeceasedDateTimeIndicates if the individual is deceased or not.notDefined
Patient_deceasedDateTimeExtensions for deceasedDateTimeElement
PatientaddressAn address for the individual.Address
PatientmaritalStatusThis field contains a patient's most recent marital (civil) status.CodeableConcept
PatientmultipleBirthBooleanIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).notDefined
Patient_multipleBirthBooleanExtensions for multipleBirthBooleanElement
PatientmultipleBirthIntegerIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).notDefined
Patient_multipleBirthIntegerExtensions for multipleBirthIntegerElement
PatientphotoImage of the patient.Attachment
PatientcontactA contact party (e.g. guardian, partner, friend) for the patient.Patient_Contact
PatientcommunicationA language which may be used to communicate with the patient about his or her health.Patient_Communication
PatientgeneralPractitionerPatient's nominated care provider.Reference
PatientmanagingOrganizationOrganization that is the custodian of the patient record.Reference
linkLink to another patient resource that concerns the same actual patient.Patient_Link
Patient_CommunicationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Patient_CommunicationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CommunicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CommunicationlanguageThe 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_CommunicationpreferredIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).boolean
Patient_Communication_preferredExtensions for preferredElement
Patient_ContactidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Patient_ContactextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContactmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContactrelationshipThe nature of the relationship between the patient and the contact person.CodeableConcept
Patient_ContactnameA name associated with the contact person.HumanName
Patient_ContacttelecomA contact detail for the person, e.g. a telephone number or an email address.ContactPoint
Patient_ContactaddressAddress for the contact person.Address
Patient_ContactgenderAdministrative 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_genderExtensions for genderElement
Patient_ContactorganizationOrganization on behalf of which the contact is acting or for which the contact is working.Reference
Patient_ContactperiodThe period during which this contact person or organization is valid to be contacted relating to this patient.Period
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
otherThe other patient resource that the link refers to.Reference
typeThe type of link between this patient resource and another patient resource.enum values:
replaced-by
replaces
refer
seealso
_typeExtensions for typeElement
PaymentNoticeresourceTypeThis is a PaymentNotice resourcePaymentNotice
PaymentNoticeidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PaymentNoticemetaThe metadata about the resource. 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
PaymentNoticeimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
PaymentNoticelanguageThe base language in which the resource is written.code
PaymentNotice_languageExtensions for languageElement
PaymentNoticetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PaymentNoticecontainedThese 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
PaymentNoticeextensionMay be 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
PaymentNoticemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PaymentNoticeidentifierA unique identifier assigned to this payment notice.Identifier
PaymentNoticestatusThe status of the resource instance.code
PaymentNotice_statusExtensions for statusElement
PaymentNoticerequestReference of resource for which payment is being made.Reference
PaymentNoticeresponseReference of response to resource for which payment is being made.Reference
PaymentNoticecreatedThe date when this resource was created.dateTime
PaymentNotice_createdExtensions for createdElement
PaymentNoticeproviderThe practitioner who is responsible for the services rendered to the patient.Reference
PaymentNoticepaymentA reference to the payment which is the subject of this notice.Reference
PaymentNoticepaymentDateThe date when the above payment action occurred.date
PaymentNotice_paymentDateExtensions for paymentDateElement
PaymentNoticepayeeThe party who will receive or has received payment that is the subject of this notification.Reference
PaymentNoticerecipientThe party who is notified of the payment status.Reference
PaymentNoticeamountThe amount sent to the payee.Money
PaymentNoticepaymentStatusA code indicating whether payment has been sent or cleared.CodeableConcept
PaymentReconciliationresourceTypeThis is a PaymentReconciliation resourcePaymentReconciliation
PaymentReconciliationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PaymentReconciliationmetaThe metadata about the resource. 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
PaymentReconciliationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
PaymentReconciliationlanguageThe base language in which the resource is written.code
PaymentReconciliation_languageExtensions for languageElement
PaymentReconciliationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PaymentReconciliationcontainedThese 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
PaymentReconciliationextensionMay be 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
PaymentReconciliationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PaymentReconciliationidentifierA unique identifier assigned to this payment reconciliation.Identifier
PaymentReconciliationstatusThe status of the resource instance.code
PaymentReconciliation_statusExtensions for statusElement
PaymentReconciliationperiodThe period of time for which payments have been gathered into this bulk payment for settlement.Period
PaymentReconciliationcreatedThe date when the resource was created.dateTime
PaymentReconciliation_createdExtensions for createdElement
PaymentReconciliationpaymentIssuerThe party who generated the payment.Reference
PaymentReconciliationrequestOriginal request resource reference.Reference
PaymentReconciliationrequestorThe practitioner who is responsible for the services rendered to the patient.Reference
PaymentReconciliationoutcomeThe outcome of a request for a reconciliation.enum values:
queued
complete
error
partial
PaymentReconciliation_outcomeExtensions for outcomeElement
PaymentReconciliationdispositionA human readable description of the status of the request for the reconciliation.string
PaymentReconciliation_dispositionExtensions for dispositionElement
PaymentReconciliationpaymentDateThe date of payment as indicated on the financial instrument.date
PaymentReconciliation_paymentDateExtensions for paymentDateElement
PaymentReconciliationpaymentAmountTotal payment amount as indicated on the financial instrument.Money
PaymentReconciliationpaymentIdentifierIssuer's unique identifier for the payment instrument.Identifier
PaymentReconciliationdetailDistribution of the payment amount for a previously acknowledged payable.PaymentReconciliation_Detail
PaymentReconciliationformCodeA code for the form to be used for printing the content.CodeableConcept
PaymentReconciliationprocessNoteA note that describes or explains the processing in a human readable form.PaymentReconciliation_ProcessNote
PaymentReconciliation_DetailidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PaymentReconciliation_DetailextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DetailmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DetailidentifierUnique identifier for the current payment item for the referenced payable.Identifier
PaymentReconciliation_DetailpredecessorUnique identifier for the prior payment item for the referenced payable.Identifier
PaymentReconciliation_DetailtypeCode to indicate the nature of the payment.CodeableConcept
PaymentReconciliation_DetailrequestA resource, such as a Claim, the evaluation of which could lead to payment.Reference
PaymentReconciliation_DetailsubmitterThe party which submitted the claim or financial transaction.Reference
PaymentReconciliation_DetailresponseA resource, such as a ClaimResponse, which contains a commitment to payment.Reference
PaymentReconciliation_DetaildateThe date from the response resource containing a commitment to pay.date
PaymentReconciliation_Detail_dateExtensions for dateElement
PaymentReconciliation_DetailresponsibleA reference to the individual who is responsible for inquiries regarding the response and its payment.Reference
PaymentReconciliation_DetailpayeeThe party which is receiving the payment.Reference
PaymentReconciliation_DetailamountThe monetary amount allocated from the total payment to the payable.Money
PaymentReconciliation_ProcessNoteidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PaymentReconciliation_ProcessNoteextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProcessNotemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcessNotetypeThe business purpose of the note text.enum values:
display
print
printoper
PaymentReconciliation_ProcessNote_typeExtensions for typeElement
PaymentReconciliation_ProcessNotetextThe explanation or description associated with the processing.string
PaymentReconciliation_ProcessNote_textExtensions for textElement
PeriodidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PeriodextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
PeriodstartThe start of the period. The boundary is inclusive.dateTime
Period_startExtensions for startElement
PeriodendThe 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_endExtensions for endElement
PermissionresourceTypeThis is a Permission resourcePermission
PermissionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PermissionmetaThe metadata about the resource. 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
PermissionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
Permission_implicitRulesExtensions for implicitRulesElement
PermissionlanguageThe base language in which the resource is written.code
Permission_languageExtensions for languageElement
PermissiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PermissioncontainedThese 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
PermissionextensionMay be 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
PermissionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PermissionstatusStatus.enum values:
active
entered-in-error
draft
rejected
Permission_statusExtensions for statusElement
Permissionintentgrant|refuse.CodeableConcept
PermissionasserterThe person or entity that asserts the permission.Reference
PermissionassertionDateThe date that permission was asserted.dateTime
Permission_assertionDateExtensions for assertionDateElement
PermissionvalidityThe period in which the permission is active.Period
PermissionpurposeThe purpose for which the permission is given.CodeableConcept
PermissiondataScopeThis can be 1) the definition of data elements, or 2) a category or label) e.g. “sensitive”. It could also be a c) graph-like definition of a set of data elements.Expression
PermissionprocessingActivityA description or definition of which activities are allowed to be done on the data.Permission_ProcessingActivity
PermissionjustificationThe asserted justification for using the data.Permission_Justification
PermissionusageLimitationsWhat limits apply to the use of the data.CodeableConcept
Permission_JustificationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Permission_JustificationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Permission_JustificationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Permission_JustificationevidenceEvidence – reference to consent, or a contract, or a policy, or a regulation, or an attachment that contains a screenshot.Reference
Permission_JustificationgroundsThis would be a codeableconcept, or a coding, which can be constrained to , for example, the 6 grounds for processing in GDPR.CodeableConcept
Permission_ProcessingActivityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Permission_ProcessingActivityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Permission_ProcessingActivitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Permission_ProcessingActivitypartyReferenceIf the processing is a transfer, we must capture where it the data allowed or expected to be shared - with a party or person.Reference
Permission_ProcessingActivitypartyCodeableConceptIf the processing is a transfer, or involves another party, we must capture where it the data allowed or expected to be shared - with a party or person. This can be a party instance or party type § Purpose – a specific purpose of the data.CodeableConcept
Permission_ProcessingActivitypurposeThe purpose for which the permission is given.CodeableConcept
PersonresourceTypeThis is a Person resourcePerson
PersonidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PersonmetaThe metadata about the resource. 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
PersonimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
PersonlanguageThe base language in which the resource is written.code
Person_languageExtensions for languageElement
PersontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PersoncontainedThese 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
PersonextensionMay be 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
PersonmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PersonidentifierIdentifier for a person within a particular scope.Identifier
PersonnameA name associated with the person.HumanName
PersontelecomA contact detail for the person, e.g. a telephone number or an email address.ContactPoint
PersongenderAdministrative Gender.enum values:
male
female
other
unknown
Person_genderExtensions for genderElement
PersonbirthDateThe birth date for the person.date
Person_birthDateExtensions for birthDateElement
PersonaddressOne or more addresses for the person.Address
PersonphotoAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual.Attachment
PersonmanagingOrganizationThe organization that is the custodian of the person record.Reference
PersonactiveWhether this person's record is in active use.boolean
Person_activeExtensions for activeElement
linkLink to a resource that concerns the same actual person.Person_Link
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
targetThe resource to which this actual person is associated.Reference
assuranceLevel of assurance that this link is associated with the target resource.enum values:
level1
level2
level3
level4
_assuranceExtensions for assuranceElement
PlanDefinitionresourceTypeThis is a PlanDefinition resourcePlanDefinition
PlanDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PlanDefinitionmetaThe metadata about the resource. 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
PlanDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
PlanDefinitionlanguageThe base language in which the resource is written.code
PlanDefinition_languageExtensions for languageElement
PlanDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PlanDefinitioncontainedThese 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
PlanDefinitionextensionMay be 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
PlanDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PlanDefinitionurlAn 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_urlExtensions for urlElement
PlanDefinitionidentifierA 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
PlanDefinitionversionThe 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_versionExtensions for versionElement
PlanDefinitionnameA 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_nameExtensions for nameElement
PlanDefinitiontitleA short, descriptive, user-friendly title for the plan definition.string
PlanDefinition_titleExtensions for titleElement
PlanDefinitionstatusThe status of this plan definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
PlanDefinition_statusExtensions for statusElement
PlanDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
PlanDefinitiondateThe 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_dateExtensions for dateElement
PlanDefinitionpublisherThe name of the organization or individual that published the plan definition.string
PlanDefinition_publisherExtensions for publisherElement
PlanDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
PlanDefinitiondescriptionA free text natural language description of the plan definition from a consumer's perspective.markdown
PlanDefinition_descriptionExtensions for descriptionElement
PlanDefinitionuseContextThe 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
PlanDefinitionjurisdictionA legal or geographic region in which the plan definition is intended to be used.CodeableConcept
PlanDefinitionpurposeExplanation of why this plan definition is needed and why it has been designed as it has.markdown
PlanDefinition_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
PlanDefinitionapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
PlanDefinition_approvalDateExtensions for approvalDateElement
PlanDefinitionlastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
PlanDefinition_lastReviewDateExtensions for lastReviewDateElement
PlanDefinitioneffectivePeriodThe period during which the plan definition content was or is planned to be in active use.Period
PlanDefinitionsubtitleAn explanatory or alternate title for the plan definition giving additional information about its content.string
PlanDefinition_subtitleExtensions for subtitleElement
PlanDefinitiontypeA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.CodeableConcept
PlanDefinitionsubjectCodeableConceptA code or group definition that describes the intended subject of the plan definition.CodeableConcept
PlanDefinitionsubjectReferenceA code or group definition that describes the intended subject of the plan definition.Reference
PlanDefinitionusageA detailed description of how the plan definition is used from a clinical perspective.string
PlanDefinition_usageExtensions for usageElement
PlanDefinitiontopicDescriptive 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
PlanDefinitionauthorAn individiual or organization primarily involved in the creation and maintenance of the content.ContactDetail
PlanDefinitioneditorAn individual or organization primarily responsible for internal coherence of the content.ContactDetail
PlanDefinitionreviewerAn individual or organization primarily responsible for review of some aspect of the content.ContactDetail
PlanDefinitionendorserAn individual or organization responsible for officially endorsing the content for use in some setting.ContactDetail
PlanDefinitionrelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.RelatedArtifact
PlanDefinitionlibraryA reference to a Library resource containing any formal logic used by the plan definition.canonical
PlanDefinitiongoalGoals 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
PlanDefinitionactionAn action or group of actions to be taken as part of the plan.PlanDefinition_Action
PlanDefinition_ActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PlanDefinition_ActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ActionprefixA user-visible prefix for the action.string
PlanDefinition_Action_prefixExtensions for prefixElement
PlanDefinition_ActiontitleThe title of the action displayed to a user.string
PlanDefinition_Action_titleExtensions for titleElement
PlanDefinition_ActiondescriptionA brief description of the action used to provide a summary to display to the user.string
PlanDefinition_Action_descriptionExtensions for descriptionElement
PlanDefinition_ActiontextEquivalentA 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_textEquivalentExtensions for textEquivalentElement
PlanDefinition_ActionpriorityIndicates how quickly the action should be addressed with respect to other actions.code
PlanDefinition_Action_priorityExtensions for priorityElement
PlanDefinition_ActioncodeA 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_ActionreasonA description of why this action is necessary or appropriate.CodeableConcept
PlanDefinition_ActiondocumentationDidactic 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_ActiongoalIdIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition.id
PlanDefinition_Action_goalIdExtensions for goalIdElement
PlanDefinition_ActionsubjectCodeableConceptA code or group definition that describes the intended subject of the action and its children, if any.CodeableConcept
PlanDefinition_ActionsubjectReferenceA code or group definition that describes the intended subject of the action and its children, if any.Reference
PlanDefinition_ActiontriggerA description of when the action should be triggered.TriggerDefinition
PlanDefinition_ActionconditionAn expression that describes applicability criteria or start/stop conditions for the action.PlanDefinition_Condition
PlanDefinition_ActioninputDefines input data requirements for the action.DataRequirement
PlanDefinition_ActionoutputDefines the outputs of the action, if any.DataRequirement
PlanDefinition_ActionrelatedActionA relationship to another action such as "before" or "30-60 minutes after start of".PlanDefinition_RelatedAction
PlanDefinition_ActiontimingDateTimeAn optional value describing when the action should be performed.notDefined
PlanDefinition_Action_timingDateTimeExtensions for timingDateTimeElement
PlanDefinition_ActiontimingAgeAn optional value describing when the action should be performed.Age
PlanDefinition_ActiontimingPeriodAn optional value describing when the action should be performed.Period
PlanDefinition_ActiontimingDurationAn optional value describing when the action should be performed.Duration
PlanDefinition_ActiontimingRangeAn optional value describing when the action should be performed.Range
PlanDefinition_ActiontimingTimingAn optional value describing when the action should be performed.Timing
PlanDefinition_ActionparticipantIndicates who should participate in performing the action described.PlanDefinition_Participant
PlanDefinition_ActiontypeThe type of action to perform (create, update, remove).CodeableConcept
PlanDefinition_ActiongroupingBehaviorDefines the grouping behavior for the action and its children.enum values:
visual-group
logical-group
sentence-group
PlanDefinition_Action_groupingBehaviorExtensions for groupingBehaviorElement
PlanDefinition_ActionselectionBehaviorDefines 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_selectionBehaviorExtensions for selectionBehaviorElement
PlanDefinition_ActionrequiredBehaviorDefines the required behavior for the action.enum values:
must
could
must-unless-documented
PlanDefinition_Action_requiredBehaviorExtensions for requiredBehaviorElement
PlanDefinition_ActionprecheckBehaviorDefines whether the action should usually be preselected.enum values:
yes
no
PlanDefinition_Action_precheckBehaviorExtensions for precheckBehaviorElement
PlanDefinition_ActioncardinalityBehaviorDefines whether the action can be selected multiple times.enum values:
single
multiple
PlanDefinition_Action_cardinalityBehaviorExtensions for cardinalityBehaviorElement
PlanDefinition_ActiondefinitionCanonicalA 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_definitionCanonicalExtensions for definitionCanonicalElement
PlanDefinition_ActiondefinitionUriA 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_definitionUriExtensions for definitionUriElement
PlanDefinition_ActiontransformA 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_ActiondynamicValueCustomizations 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_ActionactionSub 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_ConditionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PlanDefinition_ConditionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ConditionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ConditionkindThe kind of condition.enum values:
applicability
start
stop
PlanDefinition_Condition_kindExtensions for kindElement
PlanDefinition_ConditionexpressionAn expression that returns true or false, indicating whether the condition is satisfied.Expression
PlanDefinition_DynamicValueidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PlanDefinition_DynamicValueextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DynamicValuemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DynamicValuepathThe 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_pathExtensions for pathElement
PlanDefinition_DynamicValueexpressionAn expression specifying the value of the customized element.Expression
PlanDefinition_GoalidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PlanDefinition_GoalextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GoalmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GoalcategoryIndicates a category the goal falls within.CodeableConcept
PlanDefinition_GoaldescriptionHuman-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_GoalpriorityIdentifies the expected level of importance associated with reaching/sustaining the defined goal.CodeableConcept
PlanDefinition_GoalstartThe event after which the goal should begin being pursued.CodeableConcept
PlanDefinition_GoaladdressesIdentifies problems, conditions, issues, or concerns the goal is intended to address.CodeableConcept
PlanDefinition_GoaldocumentationDidactic 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_GoaltargetIndicates what should be done and within what timeframe.PlanDefinition_Target
PlanDefinition_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PlanDefinition_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipanttypeThe type of participant in the action.enum values:
patient
practitioner
related-person
device
PlanDefinition_Participant_typeExtensions for typeElement
PlanDefinition_ParticipantroleThe role the participant should play in performing the described action.CodeableConcept
PlanDefinition_RelatedActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PlanDefinition_RelatedActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RelatedActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RelatedActionactionIdThe element id of the related action.id
PlanDefinition_RelatedAction_actionIdExtensions for actionIdElement
PlanDefinition_RelatedActionrelationshipThe 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_relationshipExtensions for relationshipElement
PlanDefinition_RelatedActionoffsetDurationA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.Duration
PlanDefinition_RelatedActionoffsetRangeA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.Range
PlanDefinition_TargetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PlanDefinition_TargetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TargetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TargetmeasureThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.CodeableConcept
PlanDefinition_TargetdetailQuantityThe 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_TargetdetailRangeThe 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_TargetdetailCodeableConceptThe 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_TargetdueIndicates the timeframe after the start of the goal in which the goal should be met.Duration
PopulationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PopulationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
PopulationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
PopulationageRangeThe age of the specific population.Range
PopulationageCodeableConceptThe age of the specific population.CodeableConcept
PopulationgenderThe gender of the specific population.CodeableConcept
PopulationraceRace of the specific population.CodeableConcept
PopulationphysiologicalConditionThe existing physiological conditions of the specific population to which this applies.CodeableConcept
PractitionerresourceTypeThis is a Practitioner resourcePractitioner
PractitioneridThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PractitionermetaThe metadata about the resource. 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
PractitionerimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
PractitionerlanguageThe base language in which the resource is written.code
Practitioner_languageExtensions for languageElement
PractitionertextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PractitionercontainedThese 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
PractitionerextensionMay be 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
PractitionermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PractitioneridentifierAn identifier that applies to this person in this role.Identifier
PractitioneractiveWhether this practitioner's record is in active use.boolean
Practitioner_activeExtensions for activeElement
PractitionernameThe name(s) associated with the practitioner.HumanName
PractitionertelecomA contact detail for the practitioner, e.g. a telephone number or an email address.ContactPoint
PractitioneraddressAddress(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
PractitionergenderAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.enum values:
male
female
other
unknown
Practitioner_genderExtensions for genderElement
PractitionerbirthDateThe date of birth for the practitioner.date
Practitioner_birthDateExtensions for birthDateElement
PractitionerphotoImage of the person.Attachment
PractitionerqualificationThe 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
PractitionercommunicationA language the practitioner can use in patient communication.CodeableConcept
PractitionerRoleresourceTypeThis is a PractitionerRole resourcePractitionerRole
PractitionerRoleidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
PractitionerRolemetaThe metadata about the resource. 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
PractitionerRoleimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
PractitionerRolelanguageThe base language in which the resource is written.code
PractitionerRole_languageExtensions for languageElement
PractitionerRoletextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
PractitionerRolecontainedThese 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
PractitionerRoleextensionMay be 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
PractitionerRolemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
PractitionerRoleidentifierBusiness Identifiers that are specific to a role/location.Identifier
PractitionerRoleactiveWhether this practitioner role record is in active use.boolean
PractitionerRole_activeExtensions for activeElement
PractitionerRoleperiodThe period during which the person is authorized to act as a practitioner in these role(s) for the organization.Period
PractitionerRolepractitionerPractitioner that is able to provide the defined services for the organization.Reference
PractitionerRoleorganizationThe organization where the Practitioner performs the roles associated.Reference
PractitionerRolecodeRoles which this practitioner is authorized to perform for the organization.CodeableConcept
PractitionerRolespecialtySpecific specialty of the practitioner.CodeableConcept
PractitionerRolelocationThe location(s) at which this practitioner provides care.Reference
PractitionerRolehealthcareServiceThe list of healthcare services that this worker provides for this role's Organization/Location(s).Reference
PractitionerRoletelecomContact details that are specific to the role/location/service.ContactPoint
PractitionerRoleavailableTimeA collection of times the practitioner is available or performing this role at the location and/or healthcareservice.PractitionerRole_AvailableTime
PractitionerRolenotAvailableThe practitioner is not available or performing this role during this period of time due to the provided reason.PractitionerRole_NotAvailable
PractitionerRoleavailabilityExceptionsA 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_availabilityExceptionsExtensions for availabilityExceptionsElement
PractitionerRoleendpointTechnical endpoints providing access to services operated for the practitioner with this role.Reference
PractitionerRole_AvailableTimeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PractitionerRole_AvailableTimeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AvailableTimemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AvailableTimedaysOfWeekIndicates which days of the week are available between the start and end Times.code
PractitionerRole_AvailableTime_daysOfWeekExtensions for daysOfWeekElement
PractitionerRole_AvailableTimeallDayIs this always available? (hence times are irrelevant) e.g. 24 hour service.boolean
PractitionerRole_AvailableTime_allDayExtensions for allDayElement
PractitionerRole_AvailableTimeavailableStartTimeThe opening time of day. Note: If the AllDay flag is set, then this time is ignored.time
PractitionerRole_AvailableTime_availableStartTimeExtensions for availableStartTimeElement
PractitionerRole_AvailableTimeavailableEndTimeThe closing time of day. Note: If the AllDay flag is set, then this time is ignored.time
PractitionerRole_AvailableTime_availableEndTimeExtensions for availableEndTimeElement
PractitionerRole_NotAvailableidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PractitionerRole_NotAvailableextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_NotAvailablemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_NotAvailabledescriptionThe reason that can be presented to the user as to why this time is not available.string
PractitionerRole_NotAvailable_descriptionExtensions for descriptionElement
PractitionerRole_NotAvailableduringService is not available (seasonally or for a public holiday) from this date.Period
Practitioner_QualificationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Practitioner_QualificationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_QualificationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_QualificationidentifierAn identifier that applies to this person's qualification in this role.Identifier
Practitioner_QualificationcodeCoded representation of the qualification.CodeableConcept
Practitioner_QualificationperiodPeriod during which the qualification is valid.Period
Practitioner_QualificationissuerOrganization that regulates and issues the qualification.Reference
PrimitiveTypeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
PrimitiveTypeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ProcedureresourceTypeThis is a Procedure resourceProcedure
ProcedureidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ProceduremetaThe metadata about the resource. 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
ProcedureimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ProcedurelanguageThe base language in which the resource is written.code
Procedure_languageExtensions for languageElement
ProceduretextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ProcedurecontainedThese 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
ProcedureextensionMay be 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
ProceduremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ProcedureidentifierBusiness 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
ProcedureinstantiatesCanonicalThe 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
ProcedureinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
ProcedurebasedOnA reference to a resource that contains details of the request for this procedure.Reference
ProcedurepartOfA larger event of which this particular procedure is a component or step.Reference
ProcedurestatusA code specifying the state of the procedure. Generally, this will be the in-progress or completed state.code
Procedure_statusExtensions for statusElement
ProcedurestatusReasonCaptures the reason for the current state of the procedure.CodeableConcept
ProcedurecategoryA code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").CodeableConcept
ProcedurecodeThe specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").CodeableConcept
ProceduresubjectThe person, animal or group on which the procedure was performed.Reference
ProcedureencounterThe Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.Reference
ProcedureoccurrenceDateTimeEstimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.notDefined
Procedure_occurrenceDateTimeExtensions for occurrenceDateTimeElement
ProcedureoccurrencePeriodEstimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.Period
ProcedureoccurrenceStringEstimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.notDefined
Procedure_occurrenceStringExtensions for occurrenceStringElement
ProcedureoccurrenceAgeEstimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.Age
ProcedureoccurrenceRangeEstimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.Range
ProcedureoccurrenceTimingEstimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.Timing
ProcedurerecordedThe date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).dateTime
Procedure_recordedExtensions for recordedElement
ProcedurerecorderIndividual who recorded the record and takes responsibility for its content.Reference
ProcedurereportedBooleanIndicates 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
Procedure_reportedBooleanExtensions for reportedBooleanElement
ProcedurereportedReferenceIndicates 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
ProcedureperformerLimited to "real" people rather than equipment.Procedure_Performer
ProcedurelocationThe location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.Reference
ProcedurereasonThe coded reason or reference why the procedure was performed. This may be a coded entity of some type, or may simply be present as text, or may be a reference to one of several resources that justify the procedure.CodeableReference
ProcedurebodySiteDetailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.CodeableConcept
ProcedureoutcomeThe outcome of the procedure - did it resolve the reasons for the procedure being performed?CodeableConcept
ProcedurereportThis could be a histology result, pathology report, surgical report, etc.Reference
ProcedurecomplicationAny 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
ProcedurecomplicationDetailAny complications that occurred during the procedure, or in the immediate post-performance period.Reference
ProcedurefollowUpIf 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
ProcedurenoteAny other notes and comments about the procedure.Annotation
ProcedurefocalDeviceA 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
ProcedureusedIdentifies medications, devices and any other substance used as part of the procedure.CodeableReference
Procedure_FocalDeviceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Procedure_FocalDeviceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FocalDevicemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FocalDeviceactionThe kind of change that happened to the device during the procedure.CodeableConcept
Procedure_FocalDevicemanipulatedThe device that was manipulated (changed) during the procedure.Reference
Procedure_PerformeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Procedure_PerformerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PerformermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PerformerfunctionDistinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.CodeableConcept
Procedure_PerformeractorIndicates who or what performed the procedure.Reference
Procedure_PerformeronBehalfOfThe organization the device or practitioner was acting on behalf of.Reference
ProdCharacteristicidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ProdCharacteristicextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ProdCharacteristicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ProdCharacteristicheightWhere 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
ProdCharacteristicwidthWhere 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
ProdCharacteristicdepthWhere 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
ProdCharacteristicweightWhere 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
ProdCharacteristicnominalVolumeWhere 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
ProdCharacteristicexternalDiameterWhere 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
ProdCharacteristicshapeWhere applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.string
ProdCharacteristic_shapeExtensions for shapeElement
ProdCharacteristiccolorWhere applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.string
ProdCharacteristic_colorExtensions for colorElement
ProdCharacteristicimprintWhere applicable, the imprint can be specified as text.string
ProdCharacteristic_imprintExtensions for imprintElement
ProdCharacteristicimageWhere applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.Attachment
ProdCharacteristicscoringWhere applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.CodeableConcept
ProductShelfLifeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ProductShelfLifeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ProductShelfLifemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
ProductShelfLifeidentifierUnique identifier for the packaged Medicinal Product.Identifier
ProductShelfLifetypeThis 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
ProductShelfLifeperiodThe 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
ProductShelfLifespecialPrecautionsForStorageSpecial 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
ProvenanceresourceTypeThis is a Provenance resourceProvenance
ProvenanceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ProvenancemetaThe metadata about the resource. 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
ProvenanceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ProvenancelanguageThe base language in which the resource is written.code
Provenance_languageExtensions for languageElement
ProvenancetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ProvenancecontainedThese 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
ProvenanceextensionMay be 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
ProvenancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ProvenancetargetThe 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
ProvenanceoccurredPeriodThe period during which the activity occurred.Period
ProvenanceoccurredDateTimeThe period during which the activity occurred.notDefined
Provenance_occurredDateTimeExtensions for occurredDateTimeElement
ProvenancerecordedThe instant of time at which the activity was recorded.instant
Provenance_recordedExtensions for recordedElement
ProvenancepolicyPolicy 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_policyExtensions for policyElement
ProvenancelocationWhere the activity occurred, if relevant.Reference
ProvenancereasonThe reason that the activity was taking place.CodeableConcept
ProvenanceactivityAn 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
ProvenanceagentAn actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.Provenance_Agent
ProvenanceentityAn entity used in this activity.Provenance_Entity
ProvenancesignatureA digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.Signature
Provenance_AgentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Provenance_AgentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AgentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AgenttypeThe primary act of participation of the agent with respect to the activity.CodeableConcept
Provenance_AgentroleThe functional or structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.CodeableConcept
Provenance_AgentwhoThe individual, device or organization that participated in the event.Reference
Provenance_AgentonBehalfOfThe individual, device, or organization for whom the change was made.Reference
Provenance_EntityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Provenance_EntityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EntitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EntityroleHow the entity was used during the activity.enum values:
derivation
revision
quotation
source
removal
Provenance_Entity_roleExtensions for roleElement
Provenance_EntitywhatIdentity of the Entity used. May be a logical or physical uri and maybe absolute or relative.Reference
Provenance_EntityagentThe 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
QuantityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
QuantityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
QuantityvalueThe value of the measured amount. The value includes an implicit precision in the presentation of the value.decimal
Quantity_valueExtensions for valueElement
QuantitycomparatorHow 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_comparatorExtensions for comparatorElement
QuantityunitA human-readable form of the unit.string
Quantity_unitExtensions for unitElement
QuantitysystemThe identification of the system that provides the coded form of the unit.uri
Quantity_systemExtensions for systemElement
QuantitycodeA computer processable form of the unit in some unit representation system.code
Quantity_codeExtensions for codeElement
QuestionnaireresourceTypeThis is a Questionnaire resourceQuestionnaire
QuestionnaireidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
QuestionnairemetaThe metadata about the resource. 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
QuestionnaireimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
QuestionnairelanguageThe base language in which the resource is written.code
Questionnaire_languageExtensions for languageElement
QuestionnairetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
QuestionnairecontainedThese 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
QuestionnaireextensionMay be 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
QuestionnairemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
QuestionnaireurlAn 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_urlExtensions for urlElement
QuestionnaireidentifierA 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
QuestionnaireversionThe 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_versionExtensions for versionElement
QuestionnairenameA 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_nameExtensions for nameElement
QuestionnairetitleA short, descriptive, user-friendly title for the questionnaire.string
Questionnaire_titleExtensions for titleElement
QuestionnairestatusThe status of this questionnaire. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
Questionnaire_statusExtensions for statusElement
QuestionnaireexperimentalA 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_experimentalExtensions for experimentalElement
QuestionnairedateThe 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_dateExtensions for dateElement
QuestionnairepublisherThe name of the organization or individual that published the questionnaire.string
Questionnaire_publisherExtensions for publisherElement
QuestionnairecontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
QuestionnairedescriptionA free text natural language description of the questionnaire from a consumer's perspective.markdown
Questionnaire_descriptionExtensions for descriptionElement
QuestionnaireuseContextThe 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
QuestionnairejurisdictionA legal or geographic region in which the questionnaire is intended to be used.CodeableConcept
QuestionnairepurposeExplanation of why this questionnaire is needed and why it has been designed as it has.markdown
Questionnaire_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
QuestionnaireapprovalDateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
Questionnaire_approvalDateExtensions for approvalDateElement
QuestionnairelastReviewDateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.date
Questionnaire_lastReviewDateExtensions for lastReviewDateElement
QuestionnaireeffectivePeriodThe period during which the questionnaire content was or is planned to be in active use.Period
QuestionnairederivedFromThe URL of a Questionnaire that this Questionnaire is based on.canonical
QuestionnairesubjectTypeThe types of subjects that can be the subject of responses created for the questionnaire.code
Questionnaire_subjectTypeExtensions for subjectTypeElement
QuestionnairecodeAn identifier for this question or group of questions in a particular terminology such as LOINC.Coding
QuestionnaireitemA particular question, question grouping or display text that is part of the questionnaire.Questionnaire_Item
QuestionnaireResponseresourceTypeThis is a QuestionnaireResponse resourceQuestionnaireResponse
QuestionnaireResponseidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
QuestionnaireResponsemetaThe metadata about the resource. 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
QuestionnaireResponseimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
QuestionnaireResponselanguageThe base language in which the resource is written.code
QuestionnaireResponse_languageExtensions for languageElement
QuestionnaireResponsetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
QuestionnaireResponsecontainedThese 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
QuestionnaireResponseextensionMay be 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
QuestionnaireResponsemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
QuestionnaireResponseidentifierA business identifier assigned to a particular completed (or partially completed) questionnaire.Identifier
QuestionnaireResponsebasedOnThe 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
QuestionnaireResponsepartOfA 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
QuestionnaireResponsequestionnaireThe Questionnaire that defines and organizes the questions for which answers are being provided.canonical
QuestionnaireResponsestatusThe position of the questionnaire response within its overall lifecycle.enum values:
in-progress
completed
amended
entered-in-error
stopped
QuestionnaireResponse_statusExtensions for statusElement
QuestionnaireResponsesubjectThe 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
QuestionnaireResponseencounterThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.Reference
QuestionnaireResponseauthoredThe date and/or time that this set of answers were last changed.dateTime
QuestionnaireResponse_authoredExtensions for authoredElement
QuestionnaireResponseauthorPerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.Reference
QuestionnaireResponsesourceThe person who answered the questions about the subject.Reference
QuestionnaireResponseitemA group or question item from the original questionnaire for which answers are provided.QuestionnaireResponse_Item
QuestionnaireResponse_AnsweridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
QuestionnaireResponse_AnswerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AnswermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AnswervalueBooleanThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueBooleanExtensions for valueBooleanElement
QuestionnaireResponse_AnswervalueDecimalThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueDecimalExtensions for valueDecimalElement
QuestionnaireResponse_AnswervalueIntegerThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueIntegerExtensions for valueIntegerElement
QuestionnaireResponse_AnswervalueDateThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueDateExtensions for valueDateElement
QuestionnaireResponse_AnswervalueDateTimeThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueDateTimeExtensions for valueDateTimeElement
QuestionnaireResponse_AnswervalueTimeThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueTimeExtensions for valueTimeElement
QuestionnaireResponse_AnswervalueStringThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueStringExtensions for valueStringElement
QuestionnaireResponse_AnswervalueUriThe answer (or one of the answers) provided by the respondent to the question.notDefined
QuestionnaireResponse_Answer_valueUriExtensions for valueUriElement
QuestionnaireResponse_AnswervalueAttachmentThe answer (or one of the answers) provided by the respondent to the question.Attachment
QuestionnaireResponse_AnswervalueCodingThe answer (or one of the answers) provided by the respondent to the question.Coding
QuestionnaireResponse_AnswervalueQuantityThe answer (or one of the answers) provided by the respondent to the question.Quantity
QuestionnaireResponse_AnswervalueReferenceThe answer (or one of the answers) provided by the respondent to the question.Reference
QuestionnaireResponse_AnsweritemNested groups and/or questions found within this particular answer.QuestionnaireResponse_Item
QuestionnaireResponse_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
QuestionnaireResponse_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemlinkIdThe item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.string
QuestionnaireResponse_Item_linkIdExtensions for linkIdElement
QuestionnaireResponse_ItemdefinitionA reference to an [[[ElementDefinition]]] that provides the details for the item.uri
QuestionnaireResponse_Item_definitionExtensions for definitionElement
QuestionnaireResponse_ItemtextText that is displayed above the contents of the group or as the text of the question being answered.string
QuestionnaireResponse_Item_textExtensions for textElement
QuestionnaireResponse_ItemanswerThe respondent's answer(s) to the question.QuestionnaireResponse_Answer
QuestionnaireResponse_ItemitemQuestions or sub-groups nested beneath a question or group.QuestionnaireResponse_Item
Questionnaire_AnswerOptionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Questionnaire_AnswerOptionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AnswerOptionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AnswerOptionvalueIntegerA potential answer that's allowed as the answer to this question.notDefined
Questionnaire_AnswerOption_valueIntegerExtensions for valueIntegerElement
Questionnaire_AnswerOptionvalueDateA potential answer that's allowed as the answer to this question.notDefined
Questionnaire_AnswerOption_valueDateExtensions for valueDateElement
Questionnaire_AnswerOptionvalueTimeA potential answer that's allowed as the answer to this question.notDefined
Questionnaire_AnswerOption_valueTimeExtensions for valueTimeElement
Questionnaire_AnswerOptionvalueStringA potential answer that's allowed as the answer to this question.notDefined
Questionnaire_AnswerOption_valueStringExtensions for valueStringElement
Questionnaire_AnswerOptionvalueCodingA potential answer that's allowed as the answer to this question.Coding
Questionnaire_AnswerOptionvalueReferenceA potential answer that's allowed as the answer to this question.Reference
Questionnaire_AnswerOptioninitialSelectedIndicates whether the answer value is selected when the list of possible answers is initially shown.boolean
Questionnaire_AnswerOption_initialSelectedExtensions for initialSelectedElement
Questionnaire_EnableWhenidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Questionnaire_EnableWhenextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_EnableWhenmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_EnableWhenquestionThe linkId for the question whose answer (or lack of answer) governs whether this item is enabled.string
Questionnaire_EnableWhen_questionExtensions for questionElement
Questionnaire_EnableWhenoperatorSpecifies the criteria by which the question is enabled.enum values:
exists
=
!=
>
<
>=
<=
Questionnaire_EnableWhen_operatorExtensions for operatorElement
Questionnaire_EnableWhenanswerBooleanA value that the referenced question is tested using the specified operator in order for the item to be enabled.notDefined
Questionnaire_EnableWhen_answerBooleanExtensions for answerBooleanElement
Questionnaire_EnableWhenanswerDecimalA value that the referenced question is tested using the specified operator in order for the item to be enabled.notDefined
Questionnaire_EnableWhen_answerDecimalExtensions for answerDecimalElement
Questionnaire_EnableWhenanswerIntegerA value that the referenced question is tested using the specified operator in order for the item to be enabled.notDefined
Questionnaire_EnableWhen_answerIntegerExtensions for answerIntegerElement
Questionnaire_EnableWhenanswerDateA value that the referenced question is tested using the specified operator in order for the item to be enabled.notDefined
Questionnaire_EnableWhen_answerDateExtensions for answerDateElement
Questionnaire_EnableWhenanswerDateTimeA value that the referenced question is tested using the specified operator in order for the item to be enabled.notDefined
Questionnaire_EnableWhen_answerDateTimeExtensions for answerDateTimeElement
Questionnaire_EnableWhenanswerTimeA value that the referenced question is tested using the specified operator in order for the item to be enabled.notDefined
Questionnaire_EnableWhen_answerTimeExtensions for answerTimeElement
Questionnaire_EnableWhenanswerStringA value that the referenced question is tested using the specified operator in order for the item to be enabled.notDefined
Questionnaire_EnableWhen_answerStringExtensions for answerStringElement
Questionnaire_EnableWhenanswerCodingA value that the referenced question is tested using the specified operator in order for the item to be enabled.Coding
Questionnaire_EnableWhenanswerQuantityA value that the referenced question is tested using the specified operator in order for the item to be enabled.Quantity
Questionnaire_EnableWhenanswerReferenceA value that the referenced question is tested using the specified operator in order for the item to be enabled.Reference
Questionnaire_InitialidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Questionnaire_InitialextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InitialmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InitialvalueBooleanThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueBooleanExtensions for valueBooleanElement
Questionnaire_InitialvalueDecimalThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueDecimalExtensions for valueDecimalElement
Questionnaire_InitialvalueIntegerThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueIntegerExtensions for valueIntegerElement
Questionnaire_InitialvalueDateThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueDateExtensions for valueDateElement
Questionnaire_InitialvalueDateTimeThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueDateTimeExtensions for valueDateTimeElement
Questionnaire_InitialvalueTimeThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueTimeExtensions for valueTimeElement
Questionnaire_InitialvalueStringThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueStringExtensions for valueStringElement
Questionnaire_InitialvalueUriThe actual value to for an initial answer.notDefined
Questionnaire_Initial_valueUriExtensions for valueUriElement
Questionnaire_InitialvalueAttachmentThe actual value to for an initial answer.Attachment
Questionnaire_InitialvalueCodingThe actual value to for an initial answer.Coding
Questionnaire_InitialvalueQuantityThe actual value to for an initial answer.Quantity
Questionnaire_InitialvalueReferenceThe actual value to for an initial answer.Reference
Questionnaire_ItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Questionnaire_ItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ItemlinkIdAn identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.string
Questionnaire_Item_linkIdExtensions for linkIdElement
Questionnaire_ItemdefinitionThis 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_definitionExtensions for definitionElement
Questionnaire_ItemcodeA terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).Coding
Questionnaire_ItemprefixA 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_prefixExtensions for prefixElement
Questionnaire_ItemtextThe name of a section, the text of a question or text content for a display item.string
Questionnaire_Item_textExtensions for textElement
Questionnaire_ItemtypeThe 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
question
boolean
decimal
integer
date
dateTime
time
string
text
url
choice
open-choice
attachment
reference
quantity
Questionnaire_Item_typeExtensions for typeElement
Questionnaire_ItemenableWhenA constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.Questionnaire_EnableWhen
Questionnaire_ItemenableBehaviorControls how multiple enableWhen values are interpreted - whether all or any must be true.enum values:
all
any
Questionnaire_Item_enableBehaviorExtensions for enableBehaviorElement
Questionnaire_ItemrequiredAn 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_requiredExtensions for requiredElement
Questionnaire_ItemrepeatsAn 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_repeatsExtensions for repeatsElement
Questionnaire_ItemreadOnlyAn indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.boolean
Questionnaire_Item_readOnlyExtensions for readOnlyElement
Questionnaire_ItemmaxLengthThe maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.integer
Questionnaire_Item_maxLengthExtensions for maxLengthElement
Questionnaire_ItemanswerValueSetA reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.canonical
Questionnaire_ItemanswerOptionOne of the permitted answers for a "choice" or "open-choice" question.Questionnaire_AnswerOption
Questionnaire_IteminitialOne or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.Questionnaire_Initial
Questionnaire_ItemitemText, questions and other groups to be nested beneath a question or group.Questionnaire_Item
RangeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RangeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
RangelowThe low limit. The boundary is inclusive.Quantity
RangehighThe high limit. The boundary is inclusive.Quantity
RatioidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RatioextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
RationumeratorThe value of the numerator.Quantity
RatiodenominatorThe value of the denominator.Quantity
ReferenceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ReferenceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
ReferencereferenceA 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_referenceExtensions for referenceElement
ReferencetypeThe 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_typeExtensions for typeElement
ReferenceidentifierAn 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
ReferencedisplayPlain text narrative that identifies the resource in addition to the resource reference.string
Reference_displayExtensions for displayElement
RegulatedAuthorizationresourceTypeThis is a RegulatedAuthorization resourceRegulatedAuthorization
RegulatedAuthorizationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
RegulatedAuthorizationmetaThe metadata about the resource. 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
RegulatedAuthorizationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
RegulatedAuthorization_implicitRulesExtensions for implicitRulesElement
RegulatedAuthorizationlanguageThe base language in which the resource is written.code
RegulatedAuthorization_languageExtensions for languageElement
RegulatedAuthorizationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
RegulatedAuthorizationcontainedThese 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
RegulatedAuthorizationextensionMay be 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
RegulatedAuthorizationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
RegulatedAuthorizationidentifierBusiness identifier for the authorization, typically assigned by the authorizing body.Identifier
RegulatedAuthorizationsubjectThe type of product or service that is being authorized.Reference
RegulatedAuthorizationtypeOverall type of this authorization, for example drug marketing approval, orphan drug designation.CodeableConcept
RegulatedAuthorizationdescriptionGeneral textual supporting information.markdown
RegulatedAuthorization_descriptionExtensions for descriptionElement
RegulatedAuthorizationregionThe region (country, jurisdiction etc.) in which the marketing authorization has been granted.CodeableConcept
RegulatedAuthorizationstatusThe status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications.CodeableConcept
RegulatedAuthorizationstatusDateThe date at which the given status became applicable.dateTime
RegulatedAuthorization_statusDateExtensions for statusDateElement
RegulatedAuthorizationvalidityPeriodThe 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
RegulatedAuthorizationindicationCodeableConceptCondition for which the medicinal use applies.CodeableConcept
RegulatedAuthorizationindicationReferenceCondition for which the medicinal use applies.Reference
RegulatedAuthorizationintendedUseThe intended use of the product, e.g. prevention, treatment.CodeableConcept
RegulatedAuthorizationbasisThe legal or regulatory framework against which this authorization is granted, or other reasons for it.CodeableConcept
RegulatedAuthorizationrelatedDateOther dates associated with the authorization. It is common for an authorization to have renewal dates, initial time limited phases and so on.RegulatedAuthorization_RelatedDate
RegulatedAuthorizationjurisdictionalAuthorizationAuthorization in areas within a country.Reference
RegulatedAuthorizationholderMarketing Authorization Holder.Reference
RegulatedAuthorizationregulatorMedicines Regulatory Agency.Reference
RegulatedAuthorizationcaseThe case or regulatory procedure for granting or amending a marketing authorization.RegulatedAuthorization_Case
RegulatedAuthorization_CaseidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RegulatedAuthorization_CaseextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
RegulatedAuthorization_CasemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
RegulatedAuthorization_CaseidentifierIdentifier by which this case can be referenced.Identifier
RegulatedAuthorization_CasetypeThe defining type of case.CodeableConcept
RegulatedAuthorization_CasestatusThe status associated with the case.CodeableConcept
RegulatedAuthorization_CasedatePeriodRelevant date for this of case.Period
RegulatedAuthorization_CasedateDateTimeRelevant date for this of case.notDefined
RegulatedAuthorization_Case_dateDateTimeExtensions for dateDateTimeElement
RegulatedAuthorization_CaseapplicationApplcations submitted to obtain a marketing authorization. Steps within the longer running case or procedure.RegulatedAuthorization_Case
RegulatedAuthorization_RelatedDateidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RegulatedAuthorization_RelatedDateextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
RegulatedAuthorization_RelatedDatemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
RegulatedAuthorization_RelatedDatedatePeriodAnother date associated with the authorization.Period
RegulatedAuthorization_RelatedDatedateDateTimeAnother date associated with the authorization.notDefined
RegulatedAuthorization_RelatedDate_dateDateTimeExtensions for dateDateTimeElement
RegulatedAuthorization_RelatedDatetypeType of this date, for example the data exclusitity period for a medicinal product.CodeableConcept
RelatedArtifactidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RelatedArtifactextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
RelatedArtifacttypeThe type of relationship to the related artifact.enum values:
documentation
justification
citation
predecessor
successor
derived-from
depends-on
composed-of
RelatedArtifact_typeExtensions for typeElement
RelatedArtifactlabelA short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.string
RelatedArtifact_labelExtensions for labelElement
RelatedArtifactdisplayA brief description of the document or knowledge resource being referenced, suitable for display to a consumer.string
RelatedArtifact_displayExtensions for displayElement
RelatedArtifactcitationA bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.markdown
RelatedArtifact_citationExtensions for citationElement
RelatedArtifacturlA url for the artifact that can be followed to access the actual content.url
RelatedArtifact_urlExtensions for urlElement
RelatedArtifactdocumentThe document being referenced, represented as an attachment. This is exclusive with the resource element.Attachment
RelatedArtifactresourceThe related resource, such as a library, value set, profile, or other knowledge resource.canonical
RelatedPersonresourceTypeThis is a RelatedPerson resourceRelatedPerson
RelatedPersonidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
RelatedPersonmetaThe metadata about the resource. 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
RelatedPersonimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
RelatedPersonlanguageThe base language in which the resource is written.code
RelatedPerson_languageExtensions for languageElement
RelatedPersontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
RelatedPersoncontainedThese 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
RelatedPersonextensionMay be 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
RelatedPersonmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
RelatedPersonidentifierIdentifier for a person within a particular scope.Identifier
RelatedPersonactiveWhether this related person record is in active use.boolean
RelatedPerson_activeExtensions for activeElement
RelatedPersonpatientThe patient this person is related to.Reference
RelatedPersonrelationshipThe nature of the relationship between a patient and the related person.CodeableConcept
RelatedPersonnameA name associated with the person.HumanName
RelatedPersontelecomA contact detail for the person, e.g. a telephone number or an email address.ContactPoint
RelatedPersongenderAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.enum values:
male
female
other
unknown
RelatedPerson_genderExtensions for genderElement
RelatedPersonbirthDateThe date on which the related person was born.date
RelatedPerson_birthDateExtensions for birthDateElement
RelatedPersonaddressAddress where the related person can be contacted or visited.Address
RelatedPersonphotoImage of the person.Attachment
RelatedPersonperiodThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.Period
RelatedPersoncommunicationA language which may be used to communicate with about the patient's health.RelatedPerson_Communication
RelatedPerson_CommunicationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RelatedPerson_CommunicationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CommunicationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CommunicationlanguageThe 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_CommunicationpreferredIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).boolean
RelatedPerson_Communication_preferredExtensions for preferredElement
RequestGroupresourceTypeThis is a RequestGroup resourceRequestGroup
RequestGroupidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
RequestGroupmetaThe metadata about the resource. 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
RequestGroupimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
RequestGrouplanguageThe base language in which the resource is written.code
RequestGroup_languageExtensions for languageElement
RequestGrouptextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
RequestGroupcontainedThese 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
RequestGroupextensionMay be 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
RequestGroupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
RequestGroupidentifierAllows a service to provide a unique, business identifier for the request.Identifier
RequestGroupinstantiatesCanonicalA 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_instantiatesCanonicalExtensions for instantiatesCanonicalElement
RequestGroupinstantiatesUriA 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_instantiatesUriExtensions for instantiatesUriElement
RequestGroupbasedOnA plan, proposal or order that is fulfilled in whole or in part by this request.Reference
RequestGroupreplacesCompleted or terminated request(s) whose function is taken by this new request.Reference
RequestGroupgroupIdentifierA 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
RequestGroupstatusThe current state of the request. For request groups, the status reflects the status of all the requests in the group.code
RequestGroup_statusExtensions for statusElement
RequestGroupintentIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.code
RequestGroup_intentExtensions for intentElement
RequestGrouppriorityIndicates how quickly the request should be addressed with respect to other requests.code
RequestGroup_priorityExtensions for priorityElement
RequestGroupcodeA code that identifies what the overall request group is.CodeableConcept
RequestGroupsubjectThe subject for which the request group was created.Reference
RequestGroupencounterDescribes the context of the request group, if any.Reference
RequestGroupauthoredOnIndicates when the request group was created.dateTime
RequestGroup_authoredOnExtensions for authoredOnElement
RequestGroupauthorProvides a reference to the author of the request group.Reference
RequestGroupreasonDescribes the reason for the request group in coded or textual form.CodeableReference
RequestGroupnoteProvides a mechanism to communicate additional information about the response.Annotation
RequestGroupactionThe actions, if any, produced by the evaluation of the artifact.RequestGroup_Action
RequestGroup_ActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RequestGroup_ActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ActionprefixA user-visible prefix for the action.string
RequestGroup_Action_prefixExtensions for prefixElement
RequestGroup_ActiontitleThe title of the action displayed to a user.string
RequestGroup_Action_titleExtensions for titleElement
RequestGroup_ActiondescriptionA short description of the action used to provide a summary to display to the user.string
RequestGroup_Action_descriptionExtensions for descriptionElement
RequestGroup_ActiontextEquivalentA 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_textEquivalentExtensions for textEquivalentElement
RequestGroup_ActionpriorityIndicates how quickly the action should be addressed with respect to other actions.code
RequestGroup_Action_priorityExtensions for priorityElement
RequestGroup_ActioncodeA 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_ActiondocumentationDidactic 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_ActionconditionAn expression that describes applicability criteria, or start/stop conditions for the action.RequestGroup_Condition
RequestGroup_ActionrelatedActionA relationship to another action such as "before" or "30-60 minutes after start of".RequestGroup_RelatedAction
RequestGroup_ActiontimingDateTimeAn optional value describing when the action should be performed.notDefined
RequestGroup_Action_timingDateTimeExtensions for timingDateTimeElement
RequestGroup_ActiontimingAgeAn optional value describing when the action should be performed.Age
RequestGroup_ActiontimingPeriodAn optional value describing when the action should be performed.Period
RequestGroup_ActiontimingDurationAn optional value describing when the action should be performed.Duration
RequestGroup_ActiontimingRangeAn optional value describing when the action should be performed.Range
RequestGroup_ActiontimingTimingAn optional value describing when the action should be performed.Timing
RequestGroup_ActionparticipantThe participant that should perform or be responsible for this action.Reference
RequestGroup_ActiontypeThe type of action to perform (create, update, remove).CodeableConcept
RequestGroup_ActiongroupingBehaviorDefines the grouping behavior for the action and its children.code
RequestGroup_Action_groupingBehaviorExtensions for groupingBehaviorElement
RequestGroup_ActionselectionBehaviorDefines the selection behavior for the action and its children.code
RequestGroup_Action_selectionBehaviorExtensions for selectionBehaviorElement
RequestGroup_ActionrequiredBehaviorDefines expectations around whether an action is required.code
RequestGroup_Action_requiredBehaviorExtensions for requiredBehaviorElement
RequestGroup_ActionprecheckBehaviorDefines whether the action should usually be preselected.code
RequestGroup_Action_precheckBehaviorExtensions for precheckBehaviorElement
RequestGroup_ActioncardinalityBehaviorDefines whether the action can be selected multiple times.code
RequestGroup_Action_cardinalityBehaviorExtensions for cardinalityBehaviorElement
RequestGroup_ActionresourceThe resource that is the target of the action (e.g. CommunicationRequest).Reference
RequestGroup_ActionactionSub actions.RequestGroup_Action
RequestGroup_ConditionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RequestGroup_ConditionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ConditionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ConditionkindThe kind of condition.code
RequestGroup_Condition_kindExtensions for kindElement
RequestGroup_ConditionexpressionAn expression that returns true or false, indicating whether or not the condition is satisfied.Expression
RequestGroup_RelatedActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RequestGroup_RelatedActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RelatedActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RelatedActionactionIdThe element id of the action this is related to.id
RequestGroup_RelatedAction_actionIdExtensions for actionIdElement
RequestGroup_RelatedActionrelationshipThe relationship of this action to the related action.code
RequestGroup_RelatedAction_relationshipExtensions for relationshipElement
RequestGroup_RelatedActionoffsetDurationA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.Duration
RequestGroup_RelatedActionoffsetRangeA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.Range
ResearchStudyresourceTypeThis is a ResearchStudy resourceResearchStudy
ResearchStudyidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ResearchStudymetaThe metadata about the resource. 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
ResearchStudyimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ResearchStudylanguageThe base language in which the resource is written.code
ResearchStudy_languageExtensions for languageElement
ResearchStudytextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ResearchStudycontainedThese 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
ResearchStudyextensionMay be 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
ResearchStudymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ResearchStudyidentifierIdentifiers assigned to this research study by the sponsor or other systems.Identifier
ResearchStudytitleA short, descriptive user-friendly label for the study.string
ResearchStudy_titleExtensions for titleElement
ResearchStudyprotocolThe set of steps expected to be performed as part of the execution of the study.Reference
ResearchStudypartOfA larger research study of which this particular study is a component or step.Reference
ResearchStudystatusThe 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_statusExtensions for statusElement
ResearchStudyprimaryPurposeTypeThe type of study based upon the intent of the study's activities. A classification of the intent of the study.CodeableConcept
ResearchStudyphaseThe stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.CodeableConcept
ResearchStudycategoryCodes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.CodeableConcept
ResearchStudyfocusThe medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.CodeableConcept
ResearchStudyconditionThe 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
ResearchStudycontactContact details to assist a user in learning more about or engaging with the study.ContactDetail
ResearchStudyrelatedArtifactCitations, references and other related documents.RelatedArtifact
ResearchStudykeywordKey terms to aid in searching for or filtering the study.CodeableConcept
ResearchStudylocationIndicates a country, state or other region where the study is taking place.CodeableConcept
ResearchStudydescriptionA full description of how the study is being conducted.markdown
ResearchStudy_descriptionExtensions for descriptionElement
ResearchStudyenrollmentReference 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
ResearchStudyperiodIdentifies the start date and the expected (or actual, depending on status) end date for the study.Period
ResearchStudysponsorAn organization that initiates the investigation and is legally responsible for the study.Reference
ResearchStudyprincipalInvestigatorA 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
ResearchStudysiteA facility in which study activities are conducted.Reference
ResearchStudyreasonStoppedA description and/or code explaining the premature termination of the study.CodeableConcept
ResearchStudynoteComments made about the study by the performer, subject or other participants.Annotation
ResearchStudyarmDescribes 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
ResearchStudyobjectiveA 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_ArmidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ResearchStudy_ArmextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ArmmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ArmnameUnique, human-readable label for this arm of the study.string
ResearchStudy_Arm_nameExtensions for nameElement
ResearchStudy_ArmtypeCategorization of study arm, e.g. experimental, active comparator, placebo comparater.CodeableConcept
ResearchStudy_ArmdescriptionA succinct description of the path through the study that would be followed by a subject adhering to this arm.string
ResearchStudy_Arm_descriptionExtensions for descriptionElement
ResearchStudy_ObjectiveidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ResearchStudy_ObjectiveextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ObjectivemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ObjectivenameUnique, human-readable label for this objective of the study.string
ResearchStudy_Objective_nameExtensions for nameElement
ResearchStudy_ObjectivetypeThe kind of study objective.CodeableConcept
ResearchSubjectresourceTypeThis is a ResearchSubject resourceResearchSubject
ResearchSubjectidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ResearchSubjectmetaThe metadata about the resource. 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
ResearchSubjectimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ResearchSubjectlanguageThe base language in which the resource is written.code
ResearchSubject_languageExtensions for languageElement
ResearchSubjecttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ResearchSubjectcontainedThese 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
ResearchSubjectextensionMay be 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
ResearchSubjectmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ResearchSubjectidentifierIdentifiers assigned to this research subject for a study.Identifier
ResearchSubjectstatusThe 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_statusExtensions for statusElement
ResearchSubjectprogressThe current state (status) of the subject and resons for status change where appropriate.ResearchSubject_Progress
ResearchSubjectperiodThe dates the subject began and ended their participation in the study.Period
ResearchSubjectstudyReference to the study the subject is participating in.Reference
ResearchSubjectindividualThe record of the person or animal who is involved in the study.Reference
ResearchSubjectassignedArmThe name of the arm in the study the subject is expected to follow as part of this study.string
ResearchSubject_assignedArmExtensions for assignedArmElement
ResearchSubjectactualArmThe name of the arm in the study the subject actually followed as part of this study.string
ResearchSubject_actualArmExtensions for actualArmElement
consentA record of the patient's informed agreement to participate in the study.Reference
ResearchSubject_ProgressidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ResearchSubject_ProgressextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProgressmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProgresstypeIdentifies the aspect of the subject's journey that the state refers to.CodeableConcept
ResearchSubject_ProgressstateThe current state of the subject.CodeableConcept
ResearchSubject_ProgressmilestoneThe milestones the subject has passed through.CodeableConcept
ResearchSubject_ProgressreasonThe reason for the state change. If coded it should follow the formal subject state model.CodeableConcept
ResearchSubject_ProgressstartDateThe date when the change in status occurred.dateTime
ResearchSubject_Progress_startDateExtensions for startDateElement
RiskAssessmentresourceTypeThis is a RiskAssessment resourceRiskAssessment
RiskAssessmentidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
RiskAssessmentmetaThe metadata about the resource. 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
RiskAssessmentimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
RiskAssessmentlanguageThe base language in which the resource is written.code
RiskAssessment_languageExtensions for languageElement
RiskAssessmenttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
RiskAssessmentcontainedThese 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
RiskAssessmentextensionMay be 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
RiskAssessmentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
RiskAssessmentidentifierBusiness identifier assigned to the risk assessment.Identifier
RiskAssessmentbasedOnA reference to the request that is fulfilled by this risk assessment.Reference
RiskAssessmentparentA reference to a resource that this risk assessment is part of, such as a Procedure.Reference
RiskAssessmentstatusThe status of the RiskAssessment, using the same statuses as an Observation.code
RiskAssessment_statusExtensions for statusElement
RiskAssessmentmethodThe algorithm, process or mechanism used to evaluate the risk.CodeableConcept
RiskAssessmentcodeThe type of the risk assessment performed.CodeableConcept
RiskAssessmentsubjectThe patient or group the risk assessment applies to.Reference
RiskAssessmentencounterThe encounter where the assessment was performed.Reference
RiskAssessmentoccurrenceDateTimeThe date (and possibly time) the risk assessment was performed.notDefined
RiskAssessment_occurrenceDateTimeExtensions for occurrenceDateTimeElement
RiskAssessmentoccurrencePeriodThe date (and possibly time) the risk assessment was performed.Period
RiskAssessmentconditionFor assessments or prognosis specific to a particular condition, indicates the condition being assessed.Reference
RiskAssessmentperformerThe provider or software application that performed the assessment.Reference
RiskAssessmentreasonThe reason the risk assessment was performed.CodeableReference
RiskAssessmentbasisIndicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).Reference
RiskAssessmentpredictionDescribes the expected outcome for the subject.RiskAssessment_Prediction
RiskAssessmentmitigationA description of the steps that might be taken to reduce the identified risk(s).string
RiskAssessment_mitigationExtensions for mitigationElement
RiskAssessmentnoteAdditional comments about the risk assessment.Annotation
RiskAssessment_PredictionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
RiskAssessment_PredictionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PredictionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PredictionoutcomeOne of the potential outcomes for the patient (e.g. remission, death, a particular condition).CodeableConcept
RiskAssessment_PredictionprobabilityDecimalIndicates how likely the outcome is (in the specified timeframe).notDefined
RiskAssessment_Prediction_probabilityDecimalExtensions for probabilityDecimalElement
RiskAssessment_PredictionprobabilityRangeIndicates how likely the outcome is (in the specified timeframe).Range
RiskAssessment_PredictionqualitativeRiskIndicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).CodeableConcept
RiskAssessment_PredictionrelativeRiskIndicates 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_relativeRiskExtensions for relativeRiskElement
RiskAssessment_PredictionwhenPeriodIndicates the period of time or age range of the subject to which the specified probability applies.Period
RiskAssessment_PredictionwhenRangeIndicates the period of time or age range of the subject to which the specified probability applies.Range
RiskAssessment_PredictionrationaleAdditional information explaining the basis for the prediction.string
RiskAssessment_Prediction_rationaleExtensions for rationaleElement
SampledDataidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SampledDataextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SampledDataoriginThe base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.Quantity
SampledDataperiodThe length of time between sampling times, measured in milliseconds.decimal
SampledData_periodExtensions for periodElement
SampledDatafactorA correction factor that is applied to the sampled data points before they are added to the origin.decimal
SampledData_factorExtensions for factorElement
SampledDatalowerLimitThe 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_lowerLimitExtensions for lowerLimitElement
SampledDataupperLimitThe 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_upperLimitExtensions for upperLimitElement
SampledDatadimensionsThe 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_dimensionsExtensions for dimensionsElement
SampledDatadataA 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_dataExtensions for dataElement
ScheduleresourceTypeThis is a Schedule resourceSchedule
ScheduleidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SchedulemetaThe metadata about the resource. 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
ScheduleimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SchedulelanguageThe base language in which the resource is written.code
Schedule_languageExtensions for languageElement
ScheduletextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SchedulecontainedThese 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
ScheduleextensionMay be 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
SchedulemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ScheduleidentifierExternal Ids for this item.Identifier
ScheduleactiveWhether this schedule record is in active use or should not be used (such as was entered in error).boolean
Schedule_activeExtensions for activeElement
ScheduleserviceCategoryA broad categorization of the service that is to be performed during this appointment.CodeableConcept
ScheduleserviceTypeThe specific service that is to be performed during this appointment.CodeableConcept
SchedulespecialtyThe specialty of a practitioner that would be required to perform the service requested in this appointment.CodeableConcept
ScheduleactorSlots that reference this schedule resource provide the availability details to these referenced resource(s).Reference
ScheduleplanningHorizonThe 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
SchedulecommentComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.string
Schedule_commentExtensions for commentElement
SearchParameterresourceTypeThis is a SearchParameter resourceSearchParameter
SearchParameteridThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SearchParametermetaThe metadata about the resource. 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
SearchParameterimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SearchParameterlanguageThe base language in which the resource is written.code
SearchParameter_languageExtensions for languageElement
SearchParametertextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SearchParametercontainedThese 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
SearchParameterextensionMay be 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
SearchParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SearchParameterurlAn 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_urlExtensions for urlElement
SearchParameteridentifierA formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
SearchParameterversionThe 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_versionExtensions for versionElement
SearchParameternameA 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_nameExtensions for nameElement
SearchParametertitleA short, descriptive, user-friendly title for the {{title}}.string
SearchParameter_titleExtensions for titleElement
SearchParameterstatusThe status of this search parameter. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
SearchParameter_statusExtensions for statusElement
SearchParameterexperimentalA 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_experimentalExtensions for experimentalElement
SearchParameterdateThe 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_dateExtensions for dateElement
SearchParameterpublisherThe name of the organization or individual that published the search parameter.string
SearchParameter_publisherExtensions for publisherElement
SearchParametercontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
SearchParameterdescriptionAnd how it used.markdown
SearchParameter_descriptionExtensions for descriptionElement
SearchParameteruseContextThe 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
SearchParameterjurisdictionA legal or geographic region in which the search parameter is intended to be used.CodeableConcept
SearchParameterpurposeExplanation of why this search parameter is needed and why it has been designed as it has.markdown
SearchParameter_purposeExtensions for purposeElement
copyrightA copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.markdown
_copyrightExtensions for copyrightElement
SearchParameterderivedFromWhere 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
SearchParametercodeThe code used in the URL or the parameter name in a parameters resource for this search parameter.code
SearchParameter_codeExtensions for codeElement
SearchParameterbaseThe base resource type(s) that this search parameter can be used against.code
SearchParameter_baseExtensions for baseElement
SearchParametertypeThe 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_typeExtensions for typeElement
SearchParameterexpressionA FHIRPath expression that returns a set of elements for the search parameter.string
SearchParameter_expressionExtensions for expressionElement
SearchParameterxpathAn XPath expression that returns a set of elements for the search parameter.string
SearchParameter_xpathExtensions for xpathElement
SearchParameterxpathUsageHow the search parameter relates to the set of elements returned by evaluating the xpath query.enum values:
normal
phonetic
nearby
distance
other
SearchParameter_xpathUsageExtensions for xpathUsageElement
SearchParametertargetTypes of resource (if a resource is referenced).code
SearchParameter_targetExtensions for targetElement
SearchParametermultipleOrWhether 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_multipleOrExtensions for multipleOrElement
SearchParametermultipleAndWhether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.boolean
SearchParameter_multipleAndExtensions for multipleAndElement
SearchParametercomparatorComparators supported for the search parameter.enum values:
eq
ne
gt
lt
ge
le
sa
eb
ap
SearchParameter_comparatorExtensions for comparatorElement
SearchParametermodifierA modifier supported for the search parameter.enum values:
missing
exact
contains
not
text
in
not-in
below
above
type
identifier
ofType
SearchParameter_modifierExtensions for modifierElement
SearchParameterchainContains 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_chainExtensions for chainElement
SearchParametercomponentUsed to define the parts of a composite search parameter.SearchParameter_Component
SearchParameter_ComponentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SearchParameter_ComponentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ComponentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ComponentdefinitionThe definition of the search parameter that describes this part.canonical
SearchParameter_ComponentexpressionA sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.string
SearchParameter_Component_expressionExtensions for expressionElement
ServiceRequestresourceTypeThis is a ServiceRequest resourceServiceRequest
ServiceRequestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ServiceRequestmetaThe metadata about the resource. 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
ServiceRequestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ServiceRequestlanguageThe base language in which the resource is written.code
ServiceRequest_languageExtensions for languageElement
ServiceRequesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ServiceRequestcontainedThese 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
ServiceRequestextensionMay be 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
ServiceRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ServiceRequestidentifierIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.Identifier
ServiceRequestinstantiatesCanonicalThe 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
ServiceRequestinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
ServiceRequestbasedOnPlan/proposal/order fulfilled by this request.Reference
ServiceRequestreplacesThe request takes the place of the referenced completed or terminated request(s).Reference
ServiceRequestrequisitionA 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
ServiceRequeststatusThe status of the order.code
ServiceRequest_statusExtensions for statusElement
ServiceRequestintentWhether the request is a proposal, plan, an original order or a reflex order.code
ServiceRequest_intentExtensions for intentElement
ServiceRequestcategoryA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").CodeableConcept
ServiceRequestpriorityIndicates how quickly the ServiceRequest should be addressed with respect to other requests.code
ServiceRequest_priorityExtensions for priorityElement
ServiceRequestdoNotPerformSet this to true if the record is saying that the service/procedure should NOT be performed.boolean
ServiceRequest_doNotPerformExtensions for doNotPerformElement
ServiceRequestcodeA code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.CodeableConcept
ServiceRequestorderDetailAdditional 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
ServiceRequestquantityQuantityAn 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
ServiceRequestquantityRatioAn 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
ServiceRequestquantityRangeAn 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
ServiceRequestsubjectOn 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
ServiceRequestencounterAn encounter that provides additional information about the healthcare context in which this request is made.Reference
ServiceRequestoccurrenceDateTimeThe date/time at which the requested service should occur.notDefined
ServiceRequest_occurrenceDateTimeExtensions for occurrenceDateTimeElement
ServiceRequestoccurrencePeriodThe date/time at which the requested service should occur.Period
ServiceRequestoccurrenceTimingThe date/time at which the requested service should occur.Timing
ServiceRequestasNeededBooleanIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.notDefined
ServiceRequest_asNeededBooleanExtensions for asNeededBooleanElement
ServiceRequestasNeededCodeableConceptIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.CodeableConcept
ServiceRequestauthoredOnWhen the request transitioned to being actionable.dateTime
ServiceRequest_authoredOnExtensions for authoredOnElement
ServiceRequestrequesterThe individual who initiated the request and has responsibility for its activation.Reference
ServiceRequestperformerTypeDesired type of performer for doing the requested service.CodeableConcept
ServiceRequestperformerThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.Reference
ServiceRequestlocationThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.CodeableReference
ServiceRequestreasonAn 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`.CodeableReference
ServiceRequestinsuranceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.Reference
ServiceRequestsupportingInfoAdditional 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
ServiceRequestspecimenOne or more specimens that the laboratory procedure will use.Reference
ServiceRequestbodySiteAnatomic location where the procedure should be performed. This is the target site.CodeableConcept
ServiceRequestnoteAny other notes and comments made about the service request. For example, internal billing notes.Annotation
ServiceRequestpatientInstructionInstructions in terms that are understood by the patient or consumer.string
ServiceRequest_patientInstructionExtensions for patientInstructionElement
ServiceRequestrelevantHistoryKey events in the history of the request.Reference
SignatureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SignatureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SignaturetypeAn 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
SignaturewhenWhen the digital signature was signed.instant
Signature_whenExtensions for whenElement
SignaturewhoA reference to an application-usable description of the identity that signed (e.g. the signature used their private key).Reference
SignatureonBehalfOfA reference to an application-usable description of the identity that is represented by the signature.Reference
SignaturetargetFormatA mime type that indicates the technical format of the target resources signed by the signature.code
Signature_targetFormatExtensions for targetFormatElement
SignaturesigFormatA 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_sigFormatExtensions for sigFormatElement
SignaturedataThe base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.base64Binary
Signature_dataExtensions for dataElement
SlotresourceTypeThis is a Slot resourceSlot
SlotidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SlotmetaThe metadata about the resource. 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
SlotimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SlotlanguageThe base language in which the resource is written.code
Slot_languageExtensions for languageElement
SlottextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SlotcontainedThese 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
SlotextensionMay be 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
SlotmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SlotidentifierExternal Ids for this item.Identifier
SlotserviceCategoryA broad categorization of the service that is to be performed during this appointment.CodeableConcept
SlotserviceTypeThe 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
SlotspecialtyThe specialty of a practitioner that would be required to perform the service requested in this appointment.CodeableConcept
SlotappointmentTypeThe style of appointment or patient that may be booked in the slot (not service type).CodeableConcept
SlotscheduleThe schedule resource that this slot defines an interval of status information.Reference
Slotstatusbusy | free | busy-unavailable | busy-tentative | entered-in-error.enum values:
busy
free
busy-unavailable
busy-tentative
entered-in-error
Slot_statusExtensions for statusElement
SlotstartDate/Time that the slot is to begin.instant
Slot_startExtensions for startElement
SlotendDate/Time that the slot is to conclude.instant
Slot_endExtensions for endElement
SlotoverbookedThis slot has already been overbooked, appointments are unlikely to be accepted for this time.boolean
Slot_overbookedExtensions for overbookedElement
SlotcommentComments on the slot to describe any extended information. Such as custom constraints on the slot.string
Slot_commentExtensions for commentElement
SpecimenresourceTypeThis is a Specimen resourceSpecimen
SpecimenidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SpecimenmetaThe metadata about the resource. 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
SpecimenimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SpecimenlanguageThe base language in which the resource is written.code
Specimen_languageExtensions for languageElement
SpecimentextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SpecimencontainedThese 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
SpecimenextensionMay be 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
SpecimenmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SpecimenidentifierId for specimen.Identifier
SpecimenaccessionIdentifierThe 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
SpecimenstatusThe availability of the specimen.enum values:
available
unavailable
unsatisfactory
entered-in-error
Specimen_statusExtensions for statusElement
SpecimentypeThe kind of material that forms the specimen.CodeableConcept
SpecimensubjectWhere 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
SpecimenreceivedTimeTime when specimen was received for processing or testing.dateTime
Specimen_receivedTimeExtensions for receivedTimeElement
SpecimenparentReference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.Reference
SpecimenrequestDetails concerning a service request that required a specimen to be collected.Reference
SpecimencollectionDetails concerning the specimen collection.Specimen_Collection
SpecimenprocessingDetails concerning processing and processing steps for the specimen.Specimen_Processing
SpecimencontainerThe container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.Specimen_Container
SpecimenconditionA mode or state of being that describes the nature of the specimen.CodeableConcept
SpecimennoteTo communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).Annotation
SpecimenDefinitionresourceTypeThis is a SpecimenDefinition resourceSpecimenDefinition
SpecimenDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SpecimenDefinitionmetaThe metadata about the resource. 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
SpecimenDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SpecimenDefinitionlanguageThe base language in which the resource is written.code
SpecimenDefinition_languageExtensions for languageElement
SpecimenDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SpecimenDefinitioncontainedThese 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
SpecimenDefinitionextensionMay be 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
SpecimenDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SpecimenDefinitionurlAn absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.uri
SpecimenDefinition_urlExtensions for urlElement
SpecimenDefinitionidentifierA business identifier assigned to this SpecimenDefinition.Identifier
SpecimenDefinitionversionThe identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.string
SpecimenDefinition_versionExtensions for versionElement
SpecimenDefinitiontitleA short, descriptive, user-friendly title for the SpecimenDefinition.string
SpecimenDefinition_titleExtensions for titleElement
SpecimenDefinitionderivedFromCanonicalThe canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.canonical
SpecimenDefinitionderivedFromUriThe URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.uri
SpecimenDefinition_derivedFromUriExtensions for derivedFromUriElement
SpecimenDefinitionstatusThe current state of theSpecimenDefinition.code
SpecimenDefinition_statusExtensions for statusElement
SpecimenDefinitionexperimentalA flag to indicate that this SpecimenDefinition is not authored for genuine usage.boolean
SpecimenDefinition_experimentalExtensions for experimentalElement
SpecimenDefinitionsubjectCodeableConceptA code or group definition that describes the intended subject from which this kind of specimen is to be collected.CodeableConcept
SpecimenDefinitionsubjectReferenceA code or group definition that describes the intended subject from which this kind of specimen is to be collected.Reference
SpecimenDefinitiondateFor draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.dateTime
SpecimenDefinition_dateExtensions for dateElement
SpecimenDefinitionpublisherHelps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.Reference
SpecimenDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
SpecimenDefinitiondescriptionA free text natural language description of the SpecimenDefinition from the consumer's perspective.markdown
SpecimenDefinition_descriptionExtensions for descriptionElement
SpecimenDefinitionuseContextThe content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.UsageContext
SpecimenDefinitionjurisdictionA jurisdiction in which the SpecimenDefinition is intended to be used.CodeableConcept
SpecimenDefinitionpurposeExplains why this SpecimeDefinition is needed and why it has been designed as it has.markdown
SpecimenDefinition_purposeExtensions for purposeElement
copyrightCopyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.markdown
_copyrightExtensions for copyrightElement
SpecimenDefinitionapprovalDateThe date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
SpecimenDefinition_approvalDateExtensions for approvalDateElement
SpecimenDefinitionlastReviewDateThe date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.date
SpecimenDefinition_lastReviewDateExtensions for lastReviewDateElement
SpecimenDefinitioneffectivePeriodThe period during which the SpecimenDefinition content was or is planned to be effective.Period
SpecimenDefinitiontypeCollectedThe kind of material to be collected.CodeableConcept
SpecimenDefinitionpatientPreparationPreparation of the patient for specimen collection.CodeableConcept
SpecimenDefinitiontimeAspectTime aspect of specimen collection (duration or offset).string
SpecimenDefinition_timeAspectExtensions for timeAspectElement
SpecimenDefinitioncollectionThe action to be performed for collecting the specimen.CodeableConcept
SpecimenDefinitiontypeTestedSpecimen conditioned in a container as expected by the testing laboratory.SpecimenDefinition_TypeTested
SpecimenDefinition_AdditiveidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SpecimenDefinition_AdditiveextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AdditivemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AdditiveadditiveCodeableConceptSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.CodeableConcept
SpecimenDefinition_AdditiveadditiveReferenceSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.Reference
SpecimenDefinition_ContaineridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SpecimenDefinition_ContainerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContainermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContainermaterialThe type of material of the container.CodeableConcept
SpecimenDefinition_ContainertypeThe type of container used to contain this kind of specimen.CodeableConcept
SpecimenDefinition_ContainercapColor of container cap.CodeableConcept
SpecimenDefinition_ContainerdescriptionThe textual description of the kind of container.string
SpecimenDefinition_Container_descriptionExtensions for descriptionElement
SpecimenDefinition_ContainercapacityThe capacity (volume or other measure) of this kind of container.Quantity
SpecimenDefinition_ContainerminimumVolumeQuantityThe minimum volume to be conditioned in the container.Quantity
SpecimenDefinition_ContainerminimumVolumeStringThe minimum volume to be conditioned in the container.notDefined
SpecimenDefinition_Container_minimumVolumeStringExtensions for minimumVolumeStringElement
SpecimenDefinition_ContaineradditiveSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.SpecimenDefinition_Additive
SpecimenDefinition_ContainerpreparationSpecial processing that should be applied to the container for this kind of specimen.string
SpecimenDefinition_Container_preparationExtensions for preparationElement
SpecimenDefinition_HandlingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SpecimenDefinition_HandlingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_HandlingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_HandlingtemperatureQualifierIt 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_HandlingtemperatureRangeThe temperature interval for this set of handling instructions.Range
SpecimenDefinition_HandlingmaxDurationThe maximum time interval of preservation of the specimen with these conditions.Duration
SpecimenDefinition_HandlinginstructionAdditional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.string
SpecimenDefinition_Handling_instructionExtensions for instructionElement
SpecimenDefinition_TypeTestedidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SpecimenDefinition_TypeTestedextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TypeTestedmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TypeTestedisDerivedPrimary of secondary specimen.boolean
SpecimenDefinition_TypeTested_isDerivedExtensions for isDerivedElement
SpecimenDefinition_TypeTestedtypeThe kind of specimen conditioned for testing expected by lab.CodeableConcept
SpecimenDefinition_TypeTestedpreferenceThe preference for this type of conditioned specimen.enum values:
preferred
alternate
SpecimenDefinition_TypeTested_preferenceExtensions for preferenceElement
SpecimenDefinition_TypeTestedcontainerThe specimen's container.SpecimenDefinition_Container
SpecimenDefinition_TypeTestedrequirementRequirements for delivery and special handling of this kind of conditioned specimen.string
SpecimenDefinition_TypeTested_requirementExtensions for requirementElement
SpecimenDefinition_TypeTestedretentionTimeThe usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.Duration
SpecimenDefinition_TypeTestedsingleUseSpecimen can be used by only one test or panel if the value is "true".boolean
SpecimenDefinition_TypeTested_singleUseExtensions for singleUseElement
SpecimenDefinition_TypeTestedrejectionCriterionCriterion for rejection of the specimen in its container by the laboratory.CodeableConcept
SpecimenDefinition_TypeTestedhandlingSet of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.SpecimenDefinition_Handling
SpecimenDefinition_TypeTestedtestingDestinationWhere the specimen will be tested: e.g., lab, sector, device or any combination of these.CodeableConcept
Specimen_CollectionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Specimen_CollectionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CollectionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CollectioncollectorPerson who collected the specimen.Reference
Specimen_CollectioncollectedDateTimeTime when specimen was collected from subject - the physiologically relevant time.notDefined
Specimen_Collection_collectedDateTimeExtensions for collectedDateTimeElement
Specimen_CollectioncollectedPeriodTime when specimen was collected from subject - the physiologically relevant time.Period
Specimen_CollectiondurationThe span of time over which the collection of a specimen occurred.Duration
Specimen_CollectionquantityThe quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.Quantity
Specimen_CollectionmethodA coded value specifying the technique that is used to perform the procedure.CodeableConcept
Specimen_CollectionbodySiteAnatomical 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_CollectionfastingStatusCodeableConceptAbstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.CodeableConcept
Specimen_CollectionfastingStatusDurationAbstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.Duration
Specimen_ContaineridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Specimen_ContainerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContainermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContaineridentifierId 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_ContainerdescriptionTextual description of the container.string
Specimen_Container_descriptionExtensions for descriptionElement
Specimen_ContainertypeThe type of container associated with the specimen (e.g. slide, aliquot, etc.).CodeableConcept
Specimen_ContainercapacityThe capacity (volume or other measure) the container may contain.Quantity
Specimen_ContainerspecimenQuantityThe quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.Quantity
Specimen_ContaineradditiveCodeableConceptIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.CodeableConcept
Specimen_ContaineradditiveReferenceIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.Reference
Specimen_ProcessingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Specimen_ProcessingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ProcessingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ProcessingdescriptionTextual description of procedure.string
Specimen_Processing_descriptionExtensions for descriptionElement
Specimen_ProcessingprocedureA coded value specifying the procedure used to process the specimen.CodeableConcept
Specimen_ProcessingadditiveMaterial used in the processing step.Reference
Specimen_ProcessingtimeDateTimeA 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_timeDateTimeExtensions for timeDateTimeElement
Specimen_ProcessingtimePeriodA 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
StatisticidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StatisticextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
StatisticmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
StatisticdescriptionA description of the content value of the statistic.string
Statistic_descriptionExtensions for descriptionElement
StatisticnoteFootnotes and/or explanatory notes.Annotation
StatisticstatisticTypeType of statistic, eg relative risk.CodeableConcept
StatisticquantityStatistic value.Quantity
StatisticsampleSizeNumber of samples in the statistic.Statistic_SampleSize
StatisticattributeEstimateAn estimate of the precision of the statistic.Statistic_AttributeEstimate
Statistic_AttributeEstimateidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Statistic_AttributeEstimateextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Statistic_AttributeEstimatemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Statistic_AttributeEstimatedescriptionHuman-readable summary of the estimate.string
Statistic_AttributeEstimate_descriptionExtensions for descriptionElement
Statistic_AttributeEstimatenoteFootnote or explanatory note about the estimate.Annotation
Statistic_AttributeEstimatetypeThe estimateType of precision estimate, eg confidence interval or p value type.CodeableConcept
Statistic_AttributeEstimatequantityThe singular quantity of the precision estimate, for precision estimates represented as single values; also used to report unit of measure.Quantity
Statistic_AttributeEstimatelevelUse 95 for a 95% confidence interval.decimal
Statistic_AttributeEstimate_levelExtensions for levelElement
Statistic_AttributeEstimaterangeLower bound of confidence interval.Range
Statistic_AttributeEstimateestimateQualifierAn estimate of the precision of the estimate.Statistic_EstimateQualifier
Statistic_EstimateQualifieridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Statistic_EstimateQualifierextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Statistic_EstimateQualifiermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Statistic_EstimateQualifierdescriptionHuman-readable summary of the estimate.string
Statistic_EstimateQualifier_descriptionExtensions for descriptionElement
Statistic_EstimateQualifiernoteFootnote or explanatory note about the estimate.Annotation
Statistic_EstimateQualifiertypeThe estimateType of attribute estimate, eg confidence interval or p value type.CodeableConcept
Statistic_EstimateQualifierquantityThe singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure.Quantity
Statistic_EstimateQualifierlevelUse 95 for a 95% confidence interval.decimal
Statistic_EstimateQualifier_levelExtensions for levelElement
Statistic_EstimateQualifierrangeLower bound of confidence interval.Range
Statistic_SampleSizeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Statistic_SampleSizeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
Statistic_SampleSizemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
Statistic_SampleSizedescriptionHuman-readable summary of population sample size.string
Statistic_SampleSize_descriptionExtensions for descriptionElement
Statistic_SampleSizenoteFootnote or explanatory note about the sample size.Annotation
Statistic_SampleSizenumberOfStudiesNumber of participants in the population.integer
Statistic_SampleSize_numberOfStudiesExtensions for numberOfStudiesElement
Statistic_SampleSizenumberOfParticipantsA human-readable string to clarify or explain concepts about the sample size.integer
Statistic_SampleSize_numberOfParticipantsExtensions for numberOfParticipantsElement
Statistic_SampleSizeknownDataCountNumber of participants with known results for measured variables.integer
Statistic_SampleSize_knownDataCountExtensions for knownDataCountElement
Statistic_SampleSizenumeratorCountNumber of participants with “positive” results, only used to report actual numerator count for a proportion.integer
Statistic_SampleSize_numeratorCountExtensions for numeratorCountElement
StructureDefinitionresourceTypeThis is a StructureDefinition resourceStructureDefinition
StructureDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
StructureDefinitionmetaThe metadata about the resource. 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
StructureDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
StructureDefinitionlanguageThe base language in which the resource is written.code
StructureDefinition_languageExtensions for languageElement
StructureDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
StructureDefinitioncontainedThese 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
StructureDefinitionextensionMay be 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
StructureDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
StructureDefinitionurlAn 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_urlExtensions for urlElement
StructureDefinitionidentifierA 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
StructureDefinitionversionThe 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_versionExtensions for versionElement
StructureDefinitionnameA 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_nameExtensions for nameElement
StructureDefinitiontitleA short, descriptive, user-friendly title for the structure definition.string
StructureDefinition_titleExtensions for titleElement
StructureDefinitionstatusThe status of this structure definition. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
StructureDefinition_statusExtensions for statusElement
StructureDefinitionexperimentalA 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_experimentalExtensions for experimentalElement
StructureDefinitiondateThe 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_dateExtensions for dateElement
StructureDefinitionpublisherThe name of the organization or individual that published the structure definition.string
StructureDefinition_publisherExtensions for publisherElement
StructureDefinitioncontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
StructureDefinitiondescriptionA free text natural language description of the structure definition from a consumer's perspective.markdown
StructureDefinition_descriptionExtensions for descriptionElement
StructureDefinitionuseContextThe 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
StructureDefinitionjurisdictionA legal or geographic region in which the structure definition is intended to be used.CodeableConcept
StructureDefinitionpurposeExplanation of why this structure definition is needed and why it has been designed as it has.markdown
StructureDefinition_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
StructureDefinitionkeywordA 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
StructureDefinitionfhirVersionThe 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.4.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.0.2
3.3.0
3.5.0
4.0.0
4.0.1
4.1.0
4.2.0
4.4.0
StructureDefinition_fhirVersionExtensions for fhirVersionElement
StructureDefinitionmappingAn external specification that the content is mapped to.StructureDefinition_Mapping
StructureDefinitionkindDefines the kind of structure that this definition is describing.enum values:
primitive-type
complex-type
resource
logical
StructureDefinition_kindExtensions for kindElement
StructureDefinitionabstractWhether 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_abstractExtensions for abstractElement
StructureDefinitioncontextIdentifies the types of resource or data type elements to which the extension can be applied.StructureDefinition_Context
StructureDefinitioncontextInvariantA 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_contextInvariantExtensions for contextInvariantElement
StructureDefinitiontypeThe 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_typeExtensions for typeElement
StructureDefinitionbaseDefinitionAn absolute URI that is the base structure from which this type is derived, either by specialization or constraint.canonical
StructureDefinitionderivationHow the type relates to the baseDefinition.enum values:
specialization
constraint
StructureDefinition_derivationExtensions for derivationElement
StructureDefinitionsnapshotA snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.StructureDefinition_Snapshot
StructureDefinitiondifferentialA differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.StructureDefinition_Differential
StructureDefinition_ContextidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureDefinition_ContextextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContextmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContexttypeDefines how to interpret the expression that defines what the context of the extension is.enum values:
fhirpath
element
extension
StructureDefinition_Context_typeExtensions for typeElement
StructureDefinition_ContextexpressionAn expression that defines where an extension can be used in resources.string
StructureDefinition_Context_expressionExtensions for expressionElement
StructureDefinition_DifferentialidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureDefinition_DifferentialextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DifferentialmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DifferentialelementCaptures constraints on each element within the resource.ElementDefinition
StructureDefinition_MappingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureDefinition_MappingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MappingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MappingidentityAn Internal id that is used to identify this mapping set when specific mappings are made.id
StructureDefinition_Mapping_identityExtensions for identityElement
StructureDefinition_MappinguriAn absolute URI that identifies the specification that this mapping is expressed to.uri
StructureDefinition_Mapping_uriExtensions for uriElement
StructureDefinition_MappingnameA name for the specification that is being mapped to.string
StructureDefinition_Mapping_nameExtensions for nameElement
StructureDefinition_MappingcommentComments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.string
StructureDefinition_Mapping_commentExtensions for commentElement
StructureDefinition_SnapshotidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureDefinition_SnapshotextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SnapshotmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SnapshotelementCaptures constraints on each element within the resource.ElementDefinition
StructureMapresourceTypeThis is a StructureMap resourceStructureMap
StructureMapidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
StructureMapmetaThe metadata about the resource. 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
StructureMapimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
StructureMaplanguageThe base language in which the resource is written.code
StructureMap_languageExtensions for languageElement
StructureMaptextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
StructureMapcontainedThese 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
StructureMapextensionMay be 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
StructureMapmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
StructureMapurlAn 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_urlExtensions for urlElement
StructureMapidentifierA 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
StructureMapversionThe 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_versionExtensions for versionElement
StructureMapnameA 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_nameExtensions for nameElement
StructureMaptitleA short, descriptive, user-friendly title for the structure map.string
StructureMap_titleExtensions for titleElement
StructureMapstatusThe status of this structure map. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
StructureMap_statusExtensions for statusElement
StructureMapexperimentalA 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_experimentalExtensions for experimentalElement
StructureMapdateThe 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_dateExtensions for dateElement
StructureMappublisherThe name of the organization or individual that published the structure map.string
StructureMap_publisherExtensions for publisherElement
StructureMapcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
StructureMapdescriptionA free text natural language description of the structure map from a consumer's perspective.markdown
StructureMap_descriptionExtensions for descriptionElement
StructureMapuseContextThe 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
StructureMapjurisdictionA legal or geographic region in which the structure map is intended to be used.CodeableConcept
StructureMappurposeExplanation of why this structure map is needed and why it has been designed as it has.markdown
StructureMap_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
StructureMapstructureA structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.StructureMap_Structure
StructureMapimportOther maps used by this map (canonical URLs).canonical
StructureMapgroupOrganizes the mapping into manageable chunks for human review/ease of maintenance.StructureMap_Group
StructureMap_DependentidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_DependentextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DependentmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DependentnameName of a rule or group to apply.id
StructureMap_Dependent_nameExtensions for nameElement
StructureMap_DependentvariableVariable to pass to the rule or group.string
StructureMap_Dependent_variableExtensions for variableElement
StructureMap_GroupidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_GroupextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GroupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GroupnameA unique name for the group for the convenience of human readers.id
StructureMap_Group_nameExtensions for nameElement
StructureMap_GroupextendsAnother group that this group adds rules to.id
StructureMap_Group_extendsExtensions for extendsElement
StructureMap_GrouptypeModeIf 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_typeModeExtensions for typeModeElement
StructureMap_GroupdocumentationAdditional supporting documentation that explains the purpose of the group and the types of mappings within it.string
StructureMap_Group_documentationExtensions for documentationElement
StructureMap_GroupinputA name assigned to an instance of data. The instance must be provided when the mapping is invoked.StructureMap_Input
StructureMap_GroupruleTransform Rule from source to target.StructureMap_Rule
StructureMap_InputidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_InputextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InputmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InputnameName for this instance of data.id
StructureMap_Input_nameExtensions for nameElement
StructureMap_InputtypeType for this instance of data.string
StructureMap_Input_typeExtensions for typeElement
StructureMap_InputmodeMode for this instance of data.enum values:
source
target
StructureMap_Input_modeExtensions for modeElement
StructureMap_InputdocumentationDocumentation for this instance of data.string
StructureMap_Input_documentationExtensions for documentationElement
StructureMap_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParametervalueIdParameter value - variable or literal.notDefined
StructureMap_Parameter_valueIdExtensions for valueIdElement
StructureMap_ParametervalueStringParameter value - variable or literal.notDefined
StructureMap_Parameter_valueStringExtensions for valueStringElement
StructureMap_ParametervalueBooleanParameter value - variable or literal.notDefined
StructureMap_Parameter_valueBooleanExtensions for valueBooleanElement
StructureMap_ParametervalueIntegerParameter value - variable or literal.notDefined
StructureMap_Parameter_valueIntegerExtensions for valueIntegerElement
StructureMap_ParametervalueDecimalParameter value - variable or literal.notDefined
StructureMap_Parameter_valueDecimalExtensions for valueDecimalElement
StructureMap_RuleidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_RuleextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RulemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RulenameName of the rule for internal references.id
StructureMap_Rule_nameExtensions for nameElement
StructureMap_RulesourceSource inputs to the mapping.StructureMap_Source
StructureMap_RuletargetContent to create because of this mapping rule.StructureMap_Target
StructureMap_RuleruleRules contained in this rule.StructureMap_Rule
StructureMap_RuledependentWhich other rules to apply in the context of this rule.StructureMap_Dependent
StructureMap_RuledocumentationDocumentation for this instance of data.string
StructureMap_Rule_documentationExtensions for documentationElement
StructureMap_SourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_SourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SourcecontextType or variable this rule applies to.id
StructureMap_Source_contextExtensions for contextElement
StructureMap_SourceminSpecified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.integer
StructureMap_Source_minExtensions for minElement
StructureMap_SourcemaxSpecified 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_maxExtensions for maxElement
StructureMap_SourcetypeSpecified type for the element. This works as a condition on the mapping - use for polymorphic elements.string
StructureMap_Source_typeExtensions for typeElement
StructureMap_SourcedefaultValueBase64BinaryA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueBase64BinaryExtensions for defaultValueBase64BinaryElement
StructureMap_SourcedefaultValueBooleanA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueBooleanExtensions for defaultValueBooleanElement
StructureMap_SourcedefaultValueCanonicalA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueCanonicalExtensions for defaultValueCanonicalElement
StructureMap_SourcedefaultValueCodeA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueCodeExtensions for defaultValueCodeElement
StructureMap_SourcedefaultValueDateA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueDateExtensions for defaultValueDateElement
StructureMap_SourcedefaultValueDateTimeA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueDateTimeExtensions for defaultValueDateTimeElement
StructureMap_SourcedefaultValueDecimalA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueDecimalExtensions for defaultValueDecimalElement
StructureMap_SourcedefaultValueIdA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueIdExtensions for defaultValueIdElement
StructureMap_SourcedefaultValueInstantA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueInstantExtensions for defaultValueInstantElement
StructureMap_SourcedefaultValueIntegerA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueIntegerExtensions for defaultValueIntegerElement
StructureMap_SourcedefaultValueInteger64A value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueInteger64Extensions for defaultValueInteger64Element
StructureMap_SourcedefaultValueMarkdownA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueMarkdownExtensions for defaultValueMarkdownElement
StructureMap_SourcedefaultValueOidA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueOidExtensions for defaultValueOidElement
StructureMap_SourcedefaultValuePositiveIntA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValuePositiveIntExtensions for defaultValuePositiveIntElement
StructureMap_SourcedefaultValueStringA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueStringExtensions for defaultValueStringElement
StructureMap_SourcedefaultValueTimeA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueTimeExtensions for defaultValueTimeElement
StructureMap_SourcedefaultValueUnsignedIntA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueUnsignedIntExtensions for defaultValueUnsignedIntElement
StructureMap_SourcedefaultValueUriA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueUriExtensions for defaultValueUriElement
StructureMap_SourcedefaultValueUrlA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueUrlExtensions for defaultValueUrlElement
StructureMap_SourcedefaultValueUuidA value to use if there is no existing value in the source object.notDefined
StructureMap_Source_defaultValueUuidExtensions for defaultValueUuidElement
StructureMap_SourcedefaultValueAddressA value to use if there is no existing value in the source object.Address
StructureMap_SourcedefaultValueAgeA value to use if there is no existing value in the source object.Age
StructureMap_SourcedefaultValueAnnotationA value to use if there is no existing value in the source object.Annotation
StructureMap_SourcedefaultValueAttachmentA value to use if there is no existing value in the source object.Attachment
StructureMap_SourcedefaultValueCodeableConceptA value to use if there is no existing value in the source object.CodeableConcept
StructureMap_SourcedefaultValueCodingA value to use if there is no existing value in the source object.Coding
StructureMap_SourcedefaultValueContactPointA value to use if there is no existing value in the source object.ContactPoint
StructureMap_SourcedefaultValueCountA value to use if there is no existing value in the source object.Count
StructureMap_SourcedefaultValueDistanceA value to use if there is no existing value in the source object.Distance
StructureMap_SourcedefaultValueDurationA value to use if there is no existing value in the source object.Duration
StructureMap_SourcedefaultValueHumanNameA value to use if there is no existing value in the source object.HumanName
StructureMap_SourcedefaultValueIdentifierA value to use if there is no existing value in the source object.Identifier
StructureMap_SourcedefaultValueMoneyA value to use if there is no existing value in the source object.Money
StructureMap_SourcedefaultValuePeriodA value to use if there is no existing value in the source object.Period
StructureMap_SourcedefaultValueQuantityA value to use if there is no existing value in the source object.Quantity
StructureMap_SourcedefaultValueRangeA value to use if there is no existing value in the source object.Range
StructureMap_SourcedefaultValueRatioA value to use if there is no existing value in the source object.Ratio
StructureMap_SourcedefaultValueReferenceA value to use if there is no existing value in the source object.Reference
StructureMap_SourcedefaultValueSampledDataA value to use if there is no existing value in the source object.SampledData
StructureMap_SourcedefaultValueSignatureA value to use if there is no existing value in the source object.Signature
StructureMap_SourcedefaultValueTimingA value to use if there is no existing value in the source object.Timing
StructureMap_SourcedefaultValueContactDetailA value to use if there is no existing value in the source object.ContactDetail
StructureMap_SourcedefaultValueContributorA value to use if there is no existing value in the source object.Contributor
StructureMap_SourcedefaultValueDataRequirementA value to use if there is no existing value in the source object.DataRequirement
StructureMap_SourcedefaultValueExpressionA value to use if there is no existing value in the source object.Expression
StructureMap_SourcedefaultValueParameterDefinitionA value to use if there is no existing value in the source object.ParameterDefinition
StructureMap_SourcedefaultValueRelatedArtifactA value to use if there is no existing value in the source object.RelatedArtifact
StructureMap_SourcedefaultValueTriggerDefinitionA value to use if there is no existing value in the source object.TriggerDefinition
StructureMap_SourcedefaultValueUsageContextA value to use if there is no existing value in the source object.UsageContext
StructureMap_SourcedefaultValueDosageA value to use if there is no existing value in the source object.Dosage
StructureMap_SourcedefaultValueMetaA value to use if there is no existing value in the source object.Meta
StructureMap_SourceelementOptional field for this source.string
StructureMap_Source_elementExtensions for elementElement
StructureMap_SourcelistModeHow to handle the list mode for this element.enum values:
first
not_first
last
not_last
only_one
StructureMap_Source_listModeExtensions for listModeElement
StructureMap_SourcevariableNamed context for field, if a field is specified.id
StructureMap_Source_variableExtensions for variableElement
StructureMap_SourceconditionFHIRPath expression - must be true or the rule does not apply.string
StructureMap_Source_conditionExtensions for conditionElement
StructureMap_SourcecheckFHIRPath expression - must be true or the mapping engine throws an error instead of completing.string
StructureMap_Source_checkExtensions for checkElement
StructureMap_SourcelogMessageA FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.string
StructureMap_Source_logMessageExtensions for logMessageElement
StructureMap_StructureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_StructureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StructuremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StructureurlThe canonical reference to the structure.canonical
StructureMap_StructuremodeHow the referenced structure is used in this mapping.enum values:
source
queried
target
produced
StructureMap_Structure_modeExtensions for modeElement
StructureMap_StructurealiasThe name used for this type in the map.string
StructureMap_Structure_aliasExtensions for aliasElement
StructureMap_StructuredocumentationDocumentation that describes how the structure is used in the mapping.string
StructureMap_Structure_documentationExtensions for documentationElement
StructureMap_TargetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
StructureMap_TargetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TargetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TargetcontextType or variable this rule applies to.id
StructureMap_Target_contextExtensions for contextElement
StructureMap_TargetcontextTypeHow to interpret the context.enum values:
type
variable
StructureMap_Target_contextTypeExtensions for contextTypeElement
StructureMap_TargetelementField to create in the context.string
StructureMap_Target_elementExtensions for elementElement
StructureMap_TargetvariableNamed context for field, if desired, and a field is specified.id
StructureMap_Target_variableExtensions for variableElement
StructureMap_TargetlistModeIf field is a list, how to manage the list.enum values:
first
share
last
collate
StructureMap_Target_listModeExtensions for listModeElement
StructureMap_TargetlistRuleIdInternal rule reference for shared list items.id
StructureMap_Target_listRuleIdExtensions for listRuleIdElement
StructureMap_TargettransformHow 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_transformExtensions for transformElement
StructureMap_TargetparameterParameters to the transform.StructureMap_Parameter
SubscriptionresourceTypeThis is a Subscription resourceSubscription
SubscriptionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubscriptionmetaThe metadata about the resource. 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
SubscriptionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SubscriptionlanguageThe base language in which the resource is written.code
Subscription_languageExtensions for languageElement
SubscriptiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubscriptioncontainedThese 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
SubscriptionextensionMay be 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
SubscriptionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubscriptionidentifierA 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
SubscriptionnameA natural language name identifying the subscription.string
Subscription_nameExtensions for nameElement
SubscriptionstatusThe status of the subscription, which marks the server state for managing the subscription.code
Subscription_statusExtensions for statusElement
SubscriptiontopicThe reference to the subscription topic to be notified about.Reference
SubscriptioncontactContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.ContactPoint
SubscriptionendThe time for the server to turn the subscription off.instant
Subscription_endExtensions for endElement
SubscriptionreasonA description of why this subscription is defined.string
Subscription_reasonExtensions for reasonElement
SubscriptionfilterByThe filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND).Subscription_FilterBy
SubscriptionerrorA record of the last error that occurred when the server processed a notification.CodeableConcept
SubscriptionchannelTypeThe type of channel to send notifications on.Coding
SubscriptionendpointThe url that describes the actual end-point to send messages to.url
Subscription_endpointExtensions for endpointElement
SubscriptionheaderAdditional headers / information to send as part of the notification.string
Subscription_headerExtensions for headerElement
SubscriptionheartbeatPeriodIf present, a 'hearbeat" notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.unsignedInt
Subscription_heartbeatPeriodExtensions for heartbeatPeriodElement
SubscriptiontimeoutIf present, the maximum amount of time a server will allow before failing a notification attempt.unsignedInt
Subscription_timeoutExtensions for timeoutElement
SubscriptioncontentTypeThe mime type to send the payload in - either application/fhir+xml, or application/fhir+json. The MIME types "text/plain" and "text/html" may also be used for Email subscriptions.code
Subscription_contentTypeExtensions for contentTypeElement
SubscriptioncontentHow much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.enum values:
empty
id-only
full-resource
Subscription_contentExtensions for contentElement
SubscriptionStatusresourceTypeThis is a SubscriptionStatus resourceSubscriptionStatus
SubscriptionStatusidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubscriptionStatusmetaThe metadata about the resource. 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
SubscriptionStatusimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
SubscriptionStatus_implicitRulesExtensions for implicitRulesElement
SubscriptionStatuslanguageThe base language in which the resource is written.code
SubscriptionStatus_languageExtensions for languageElement
SubscriptionStatustextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubscriptionStatuscontainedThese 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
SubscriptionStatusextensionMay be 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
SubscriptionStatusmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubscriptionStatusnotificationTypeThe type of event being conveyed with this notificaiton.enum values:
handshake
heartbeat
event-notification
SubscriptionStatus_notificationTypeExtensions for notificationTypeElement
SubscriptionStatuseventsSinceSubscriptionStartThe total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.integer64
SubscriptionStatus_eventsSinceSubscriptionStartExtensions for eventsSinceSubscriptionStartElement
SubscriptionStatuseventsInNotificationThe total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching.integer
SubscriptionStatus_eventsInNotificationExtensions for eventsInNotificationElement
SubscriptionStatussubscriptionThe reference to the Subscription which generated this notification.Reference
SubscriptionStatusstatusThe status of the subscription, which marks the server state for managing the subscription.code
SubscriptionStatus_statusExtensions for statusElement
SubscriptionStatustopicThe reference to the SubscriptionTopic for the Subscription which generated this notification.Reference
SubscriptionTopicresourceTypeThis is a SubscriptionTopic resourceSubscriptionTopic
SubscriptionTopicidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubscriptionTopicmetaThe metadata about the resource. 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
SubscriptionTopicimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
SubscriptionTopic_implicitRulesExtensions for implicitRulesElement
SubscriptionTopiclanguageThe base language in which the resource is written.code
SubscriptionTopic_languageExtensions for languageElement
SubscriptionTopictextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubscriptionTopiccontainedThese 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
SubscriptionTopicextensionMay be 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
SubscriptionTopicmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubscriptionTopicurlAn absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see [Technical and Business Versions](resource.html#versions).uri
SubscriptionTopic_urlExtensions for urlElement
SubscriptionTopicidentifierBusiness identifiers assigned to this SubscriptionTopic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.Identifier
SubscriptionTopicversionThe identifier that is used to identify this version of the SubscriptionTopic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.string
SubscriptionTopic_versionExtensions for versionElement
SubscriptionTopictitleA short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".string
SubscriptionTopic_titleExtensions for titleElement
SubscriptionTopicderivedFromCanonicalThe canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.canonical
SubscriptionTopicderivedFromUriThe URL pointing to an externally-defined SubscriptionTopic or other definition that is adhered to in whole or in part by this definition.uri
SubscriptionTopic_derivedFromUriExtensions for derivedFromUriElement
SubscriptionTopicstatusThe current state of the SubscriptionTopic.enum values:
draft
active
retired
unknown
SubscriptionTopic_statusExtensions for statusElement
SubscriptionTopicexperimentalA flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.boolean
SubscriptionTopic_experimentalExtensions for experimentalElement
SubscriptionTopicdateFor draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.dateTime
SubscriptionTopic_dateExtensions for dateElement
SubscriptionTopicpublisherHelps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.Reference
SubscriptionTopiccontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
SubscriptionTopicdescriptionA free text natural language description of the Topic from the consumer's perspective.markdown
SubscriptionTopic_descriptionExtensions for descriptionElement
SubscriptionTopicuseContextThe content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.UsageContext
SubscriptionTopicjurisdictionA jurisdiction in which the Topic is intended to be used.CodeableConcept
SubscriptionTopicpurposeExplains why this Topic is needed and why it has been designed as it has.markdown
SubscriptionTopic_purposeExtensions for purposeElement
copyrightA copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.markdown
_copyrightExtensions for copyrightElement
SubscriptionTopicapprovalDateThe date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.date
SubscriptionTopic_approvalDateExtensions for approvalDateElement
SubscriptionTopiclastReviewDateThe date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.date
SubscriptionTopic_lastReviewDateExtensions for lastReviewDateElement
SubscriptionTopiceffectivePeriodThe period during which the SubscriptionTopic content was or is planned to be effective.Period
SubscriptionTopicresourceTriggerThe criteria for including updates to a nominated resource in the subscription topic. Thie criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression.SubscriptionTopic_ResourceTrigger
SubscriptionTopiccanFilterByList of properties by which Subscriptions on the subscription topic can be filtered.SubscriptionTopic_CanFilterBy
SubscriptionTopic_CanFilterByidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubscriptionTopic_CanFilterByextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubscriptionTopic_CanFilterBymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubscriptionTopic_CanFilterBysearchParamNameA search parameter (like "patient") which is a label for the filter.string
SubscriptionTopic_CanFilterBy_searchParamNameExtensions for searchParamNameElement
SubscriptionTopic_CanFilterBysearchModifierAllowable operators to apply when determining matches (Search Modifiers).code
SubscriptionTopic_CanFilterBy_searchModifierExtensions for searchModifierElement
SubscriptionTopic_CanFilterBydocumentationDescription of how this filter parameter is intended to be used.markdown
SubscriptionTopic_CanFilterBy_documentationExtensions for documentationElement
SubscriptionTopic_QueryCriteriaidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubscriptionTopic_QueryCriteriaextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubscriptionTopic_QueryCriteriamodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubscriptionTopic_QueryCriteriapreviousThe FHIR query based rules are applied to the previous resource state.string
SubscriptionTopic_QueryCriteria_previousExtensions for previousElement
SubscriptionTopic_QueryCriteriacurrentThe FHIR query based rules are applied to the current resource state.string
SubscriptionTopic_QueryCriteria_currentExtensions for currentElement
SubscriptionTopic_QueryCriteriarequireBothIf set to true, both current and previous criteria must evaluate true to trigger a notification for this topic. Otherwise a notification for this topic will be triggered if either one evaluates to true.boolean
SubscriptionTopic_QueryCriteria_requireBothExtensions for requireBothElement
SubscriptionTopic_ResourceTriggeridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubscriptionTopic_ResourceTriggerextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubscriptionTopic_ResourceTriggermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubscriptionTopic_ResourceTriggerdescriptionThe human readable description of what triggers inclusion into this subscription topic - for example, "Beginning of a clinical encounter".string
SubscriptionTopic_ResourceTrigger_descriptionExtensions for descriptionElement
SubscriptionTopic_ResourceTriggerresourceTypeThe list of resource types that are candidates for this subscription topic. For example, the Encounter resource is updated in an 'admission' subscription topic.code
SubscriptionTopic_ResourceTrigger_resourceTypeExtensions for resourceTypeElement
SubscriptionTopic_ResourceTriggermethodCriteriaThe REST interaction based rules that the server should use to determine when to trigger a notification for this topic.code
SubscriptionTopic_ResourceTrigger_methodCriteriaExtensions for methodCriteriaElement
SubscriptionTopic_ResourceTriggerqueryCriteriaThe FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.SubscriptionTopic_QueryCriteria
SubscriptionTopic_ResourceTriggerfhirPathCriteriaThe FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. If there are multiple, FHIRPath filters are joined with AND.string
SubscriptionTopic_ResourceTrigger_fhirPathCriteriaExtensions for fhirPathCriteriaElement
Subscription_FilterByidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Subscription_FilterByextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FilterBymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FilterBysearchParamNameThe filter label (=key) as defined in the `SubscriptionTopic.canfilterBy.searchParamName` element.string
Subscription_FilterBy_searchParamNameExtensions for searchParamNameElement
Subscription_FilterBysearchModifierThe operator to apply to the filter value when determining matches (Search modifiers).code
Subscription_FilterBy_searchModifierExtensions for searchModifierElement
Subscription_FilterByvalueThe literal value or resource path as is legal in search - for example, "Patient/123" or "le1950".string
Subscription_FilterBy_valueExtensions for valueElement
SubstanceresourceTypeThis is a Substance resourceSubstance
SubstanceidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubstancemetaThe metadata about the resource. 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
SubstanceimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SubstancelanguageThe base language in which the resource is written.code
Substance_languageExtensions for languageElement
SubstancetextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubstancecontainedThese 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
SubstanceextensionMay be 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
SubstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubstanceidentifierUnique identifier for the substance.Identifier
SubstancestatusA code to indicate if the substance is actively used.enum values:
active
inactive
entered-in-error
Substance_statusExtensions for statusElement
SubstancecategoryA code that classifies the general type of substance. This is used for searching, sorting and display purposes.CodeableConcept
SubstancecodeA code (or set of codes) that identify this substance.CodeableConcept
SubstancedescriptionA description of the substance - its appearance, handling requirements, and other usage notes.string
Substance_descriptionExtensions for descriptionElement
SubstanceinstanceSubstance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.Substance_Instance
SubstanceingredientA substance can be composed of other substances.Substance_Ingredient
SubstanceAmountidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceAmountextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceAmountmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceAmountamountQuantityUsed 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
SubstanceAmountamountRangeUsed 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
SubstanceAmountamountStringUsed 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_amountStringExtensions for amountStringElement
SubstanceAmountamountTypeMost 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
SubstanceAmountamountTextA textual comment on a numeric value.string
SubstanceAmount_amountTextExtensions for amountTextElement
SubstanceAmountreferenceRangeReference range of possible or expected values.SubstanceAmount_ReferenceRange
SubstanceAmount_ReferenceRangeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceAmount_ReferenceRangeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ReferenceRangemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ReferenceRangelowLimitLower limit possible or expected.Quantity
SubstanceAmount_ReferenceRangehighLimitUpper limit possible or expected.Quantity
SubstanceDefinitionresourceTypeThis is a SubstanceDefinition resourceSubstanceDefinition
SubstanceDefinitionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubstanceDefinitionmetaThe metadata about the resource. 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
SubstanceDefinitionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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
SubstanceDefinition_implicitRulesExtensions for implicitRulesElement
SubstanceDefinitionlanguageThe base language in which the resource is written.code
SubstanceDefinition_languageExtensions for languageElement
SubstanceDefinitiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubstanceDefinitioncontainedThese 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
SubstanceDefinitionextensionMay be 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
SubstanceDefinitionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubstanceDefinitionidentifierIdentifier by which this substance is known.Identifier
SubstanceDefinitionversionA business level identifier of the substance.string
SubstanceDefinition_versionExtensions for versionElement
SubstanceDefinitionstatusStatus of substance within the catalogue e.g. approved.CodeableConcept
SubstanceDefinitioncategoryHigh level categorization, e.g. polymer or nucleic acid, or food, chemical, biological.CodeableConcept
SubstanceDefinitiondomainIf the substance applies to only human or veterinary use.CodeableConcept
SubstanceDefinitiondescriptionTextual description of the substance.markdown
SubstanceDefinition_descriptionExtensions for descriptionElement
SubstanceDefinitionsourceSupporting literature.Reference
SubstanceDefinitionnoteTextual comment about this record of a substance.Annotation
SubstanceDefinitionmanufacturerA company that makes this substance.Reference
SubstanceDefinitionsupplierA company that supplies this substance.Reference
SubstanceDefinitionmoietyMoiety, for structural modifications.SubstanceDefinition_Moiety
SubstanceDefinitionpropertyGeneral specifications for this substance, including how it is related to other substances.SubstanceDefinition_Property
SubstanceDefinitionreferenceInformationGeneral information detailing this substance.Reference
SubstanceDefinitionstructureStructural information.SubstanceDefinition_Structure
SubstanceDefinitioncodeCodes associated with the substance.SubstanceDefinition_Code
SubstanceDefinitionnameNames applicable to this substance.SubstanceDefinition_Name
SubstanceDefinitionmolecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids).SubstanceDefinition_MolecularWeight
SubstanceDefinitionrelationshipA link between this substance and another, with details of the relationship.SubstanceDefinition_Relationship
SubstanceDefinitionnucleicAcidData items specific to nucleic acids.Reference
SubstanceDefinitionpolymerData items specific to polymers.Reference
SubstanceDefinitionproteinData items specific to proteins.Reference
SubstanceDefinitionsourceMaterialMaterial or taxonomic/anatomical source for the substance.Reference
SubstanceDefinition_CodeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_CodeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_CodemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_CodecodeThe specific code.CodeableConcept
SubstanceDefinition_CodestatusStatus of the code assignment, for example 'provisional', 'approved'.CodeableConcept
SubstanceDefinition_CodestatusDateThe date at which the code status is changed as part of the terminology maintenance.dateTime
SubstanceDefinition_Code_statusDateExtensions for statusDateElement
SubstanceDefinition_CodenoteAny comment can be provided in this field, if necessary.Annotation
SubstanceDefinition_CodesourceSupporting literature.Reference
SubstanceDefinition_IsotopeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_IsotopeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_IsotopemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_IsotopeidentifierSubstance identifier for each non-natural or radioisotope.Identifier
SubstanceDefinition_IsotopenameSubstance name for each non-natural or radioisotope.CodeableConcept
SubstanceDefinition_IsotopesubstitutionThe type of isotopic substitution present in a single substance.CodeableConcept
SubstanceDefinition_IsotopehalfLifeHalf life - for a non-natural nuclide.Quantity
SubstanceDefinition_IsotopemolecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids).SubstanceDefinition_MolecularWeight
SubstanceDefinition_MoietyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_MoietyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_MoietymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_MoietyroleRole that the moiety is playing.CodeableConcept
SubstanceDefinition_MoietyidentifierIdentifier by which this moiety substance is known.Identifier
SubstanceDefinition_MoietynameTextual name for this moiety substance.string
SubstanceDefinition_Moiety_nameExtensions for nameElement
SubstanceDefinition_MoietystereochemistryStereochemistry type.CodeableConcept
SubstanceDefinition_MoietyopticalActivityOptical activity type.CodeableConcept
SubstanceDefinition_MoietymolecularFormulaMolecular formula for this moiety of this substance, typically using the Hill system.string
SubstanceDefinition_Moiety_molecularFormulaExtensions for molecularFormulaElement
SubstanceDefinition_MoietyamountQuantityQuantitative value for this moiety.Quantity
SubstanceDefinition_MoietyamountStringQuantitative value for this moiety.notDefined
SubstanceDefinition_Moiety_amountStringExtensions for amountStringElement
SubstanceDefinition_MoietyamountTypeThe measurement type of the quantitative value.CodeableConcept
SubstanceDefinition_MolecularWeightidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_MolecularWeightextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_MolecularWeightmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_MolecularWeightmethodThe method by which the molecular weight was determined.CodeableConcept
SubstanceDefinition_MolecularWeighttypeType of molecular weight such as exact, average (also known as. number average), weight average.CodeableConcept
SubstanceDefinition_MolecularWeightamountUsed 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
SubstanceDefinition_NameidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_NameextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_NamemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_NamenameThe actual name.string
SubstanceDefinition_Name_nameExtensions for nameElement
SubstanceDefinition_NametypeName type, for example 'systematic', 'scientific, 'brand'.CodeableConcept
SubstanceDefinition_NamestatusThe status of the name, for example 'current', 'proposed'.CodeableConcept
SubstanceDefinition_NamepreferredIf this is the preferred name for this substance.boolean
SubstanceDefinition_Name_preferredExtensions for preferredElement
SubstanceDefinition_NamelanguageHuman language that the name is written in.CodeableConcept
SubstanceDefinition_NamedomainThe 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
SubstanceDefinition_NamejurisdictionThe jurisdiction where this name applies.CodeableConcept
SubstanceDefinition_NamesynonymA synonym of this particular name, by which the substance is also known.SubstanceDefinition_Name
SubstanceDefinition_NametranslationA translation for this name into another human language.SubstanceDefinition_Name
SubstanceDefinition_NameofficialDetails of the official nature of this name.SubstanceDefinition_Official
SubstanceDefinition_NamesourceSupporting literature.Reference
SubstanceDefinition_OfficialidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_OfficialextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_OfficialmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_OfficialauthorityWhich authority uses this official name.CodeableConcept
SubstanceDefinition_OfficialstatusThe status of the official name, for example 'provisional', 'approved'.CodeableConcept
SubstanceDefinition_OfficialdateDate of official name change.dateTime
SubstanceDefinition_Official_dateExtensions for dateElement
SubstanceDefinition_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_PropertycategoryA category for this property, e.g. Physical, Chemical, Enzymatic.CodeableConcept
SubstanceDefinition_PropertycodeProperty type e.g. viscosity, pH, isoelectric point.CodeableConcept
SubstanceDefinition_PropertyparametersParameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).string
SubstanceDefinition_Property_parametersExtensions for parametersElement
SubstanceDefinition_PropertydefiningSubstanceReferenceA substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).Reference
SubstanceDefinition_PropertydefiningSubstanceCodeableConceptA substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).CodeableConcept
SubstanceDefinition_PropertyamountQuantityQuantitative value for this property.Quantity
SubstanceDefinition_PropertyamountStringQuantitative value for this property.notDefined
SubstanceDefinition_Property_amountStringExtensions for amountStringElement
SubstanceDefinition_PropertyreferenceRangeRange of typical values.Range
SubstanceDefinition_PropertysourceSupporting literature.Reference
SubstanceDefinition_RelationshipidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_RelationshipextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_RelationshipmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_RelationshipsubstanceDefinitionReferenceA pointer to another substance, as a resource or just a representational code.Reference
SubstanceDefinition_RelationshipsubstanceDefinitionCodeableConceptA pointer to another substance, as a resource or just a representational code.CodeableConcept
SubstanceDefinition_RelationshiptypeFor example "salt to parent", "active moiety", "starting material", "polymorph".CodeableConcept
SubstanceDefinition_RelationshipisDefiningFor 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
SubstanceDefinition_Relationship_isDefiningExtensions for isDefiningElement
SubstanceDefinition_RelationshipamountQuantityA 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
SubstanceDefinition_RelationshipamountRangeA 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
SubstanceDefinition_RelationshipamountRatioA 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
SubstanceDefinition_RelationshipamountStringA 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
SubstanceDefinition_Relationship_amountStringExtensions for amountStringElement
SubstanceDefinition_RelationshipamountRatioHighLimitFor use when the numeric has an uncertain range.Ratio
SubstanceDefinition_RelationshipamountTypeAn operator for the amount, for example "average", "approximately", "less than".CodeableConcept
SubstanceDefinition_RelationshipsourceSupporting literature.Reference
SubstanceDefinition_RepresentationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_RepresentationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_RepresentationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_RepresentationtypeThe type of structure (e.g. Full, Partial, Representative).CodeableConcept
SubstanceDefinition_RepresentationrepresentationThe structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.string
SubstanceDefinition_Representation_representationExtensions for representationElement
SubstanceDefinition_RepresentationformatThe format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.CodeableConcept
SubstanceDefinition_RepresentationattachmentAn attached file with the structural representation.Attachment
SubstanceDefinition_StructureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceDefinition_StructureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
SubstanceDefinition_StructuremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
SubstanceDefinition_StructurestereochemistryStereochemistry type.CodeableConcept
SubstanceDefinition_StructureopticalActivityOptical activity type.CodeableConcept
SubstanceDefinition_StructuremolecularFormulaMolecular formula of this substance, typically using the Hill system.string
SubstanceDefinition_Structure_molecularFormulaExtensions for molecularFormulaElement
SubstanceDefinition_StructuremolecularFormulaByMoietySpecified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.string
SubstanceDefinition_Structure_molecularFormulaByMoietyExtensions for molecularFormulaByMoietyElement
SubstanceDefinition_StructureisotopeApplicable for single substances that contain a radionuclide or a non-natural isotopic ratio.SubstanceDefinition_Isotope
SubstanceDefinition_StructuremolecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids).SubstanceDefinition_MolecularWeight
SubstanceDefinition_StructuretechniqueThe method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay.CodeableConcept
SubstanceDefinition_StructuresourceDocumentSupporting literature about the source of information.Reference
SubstanceDefinition_StructurerepresentationMolecular structural representation.SubstanceDefinition_Representation
SubstanceNucleicAcidresourceTypeThis is a SubstanceNucleicAcid resourceSubstanceNucleicAcid
SubstanceNucleicAcididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubstanceNucleicAcidmetaThe metadata about the resource. 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
SubstanceNucleicAcidimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SubstanceNucleicAcidlanguageThe base language in which the resource is written.code
SubstanceNucleicAcid_languageExtensions for languageElement
SubstanceNucleicAcidtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubstanceNucleicAcidcontainedThese 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
SubstanceNucleicAcidextensionMay be 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
SubstanceNucleicAcidmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubstanceNucleicAcidsequenceTypeThe type of the sequence shall be specified based on a controlled vocabulary.CodeableConcept
SubstanceNucleicAcidnumberOfSubunitsThe 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_numberOfSubunitsExtensions for numberOfSubunitsElement
SubstanceNucleicAcidareaOfHybridisationThe 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_areaOfHybridisationExtensions for areaOfHybridisationElement
SubstanceNucleicAcidoligoNucleotideType(TBC).CodeableConcept
SubstanceNucleicAcidsubunitSubunits 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_LinkageidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceNucleicAcid_LinkageextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_LinkagemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_LinkageconnectivityThe 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_connectivityExtensions for connectivityElement
SubstanceNucleicAcid_LinkageidentifierEach linkage will be registered as a fragment and have an ID.Identifier
SubstanceNucleicAcid_LinkagenameEach 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_nameExtensions for nameElement
SubstanceNucleicAcid_LinkageresidueSiteResidues shall be captured as described in 5.3.6.8.3.string
SubstanceNucleicAcid_Linkage_residueSiteExtensions for residueSiteElement
SubstanceNucleicAcid_SubunitidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceNucleicAcid_SubunitextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubunitmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubunitsubunitIndex 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_subunitExtensions for subunitElement
SubstanceNucleicAcid_SubunitsequenceActual 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_sequenceExtensions for sequenceElement
SubstanceNucleicAcid_SubunitlengthThe length of the sequence shall be captured.integer
SubstanceNucleicAcid_Subunit_lengthExtensions for lengthElement
SubstanceNucleicAcid_SubunitsequenceAttachment(TBC).Attachment
SubstanceNucleicAcid_SubunitfivePrimeThe 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_SubunitthreePrimeThe 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_SubunitlinkageThe linkages between sugar residues will also be captured.SubstanceNucleicAcid_Linkage
SubstanceNucleicAcid_Subunitsugar5.3.6.8.1 Sugar ID (Mandatory).SubstanceNucleicAcid_Sugar
SubstanceNucleicAcid_SugaridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceNucleicAcid_SugarextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SugarmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SugaridentifierThe Substance ID of the sugar or sugar-like component that make up the nucleotide.Identifier
SubstanceNucleicAcid_SugarnameThe name of the sugar or sugar-like component that make up the nucleotide.string
SubstanceNucleicAcid_Sugar_nameExtensions for nameElement
SubstanceNucleicAcid_SugarresidueSiteThe 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_residueSiteExtensions for residueSiteElement
SubstancePolymerresourceTypeThis is a SubstancePolymer resourceSubstancePolymer
SubstancePolymeridThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubstancePolymermetaThe metadata about the resource. 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
SubstancePolymerimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SubstancePolymerlanguageThe base language in which the resource is written.code
SubstancePolymer_languageExtensions for languageElement
SubstancePolymertextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubstancePolymercontainedThese 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
SubstancePolymerextensionMay be 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
SubstancePolymermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubstancePolymeridentifierTodo.Identifier
SubstancePolymerclassTodo.CodeableConcept
SubstancePolymergeometryTodo.CodeableConcept
SubstancePolymercopolymerConnectivityTodo.CodeableConcept
SubstancePolymermodificationTodo. This is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder.string
SubstancePolymer_modificationExtensions for modificationElement
SubstancePolymermonomerSetTodo.SubstancePolymer_MonomerSet
SubstancePolymerrepeatTodo.SubstancePolymer_Repeat
SubstancePolymer_DegreeOfPolymerisationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstancePolymer_DegreeOfPolymerisationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DegreeOfPolymerisationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DegreeOfPolymerisationdegreeTodo.CodeableConcept
SubstancePolymer_DegreeOfPolymerisationamountTodo.SubstanceAmount
SubstancePolymer_MonomerSetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstancePolymer_MonomerSetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MonomerSetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_MonomerSetratioTypeTodo.CodeableConcept
SubstancePolymer_MonomerSetstartingMaterialTodo.SubstancePolymer_StartingMaterial
SubstancePolymer_RepeatidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstancePolymer_RepeatextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RepeatmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RepeatnumberOfUnitsTodo.integer
SubstancePolymer_Repeat_numberOfUnitsExtensions for numberOfUnitsElement
SubstancePolymer_RepeataverageMolecularFormulaTodo.string
SubstancePolymer_Repeat_averageMolecularFormulaExtensions for averageMolecularFormulaElement
SubstancePolymer_RepeatrepeatUnitAmountTypeTodo.CodeableConcept
SubstancePolymer_RepeatrepeatUnitTodo.SubstancePolymer_RepeatUnit
SubstancePolymer_RepeatUnitidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstancePolymer_RepeatUnitextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RepeatUnitmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RepeatUnitunitTodo.string
SubstancePolymer_RepeatUnit_unitExtensions for unitElement
SubstancePolymer_RepeatUnitorientationTodo.CodeableConcept
SubstancePolymer_RepeatUnitamountTodo.SubstanceAmount
SubstancePolymer_RepeatUnitdegreeOfPolymerisationTodo.SubstancePolymer_DegreeOfPolymerisation
SubstancePolymer_RepeatUnitstructuralRepresentationTodo.SubstancePolymer_StructuralRepresentation
SubstancePolymer_StartingMaterialidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstancePolymer_StartingMaterialextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StartingMaterialmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StartingMaterialcodeTodo.CodeableConcept
SubstancePolymer_StartingMaterialcategoryTodo.CodeableConcept
SubstancePolymer_StartingMaterialisDefiningTodo.boolean
SubstancePolymer_StartingMaterial_isDefiningExtensions for isDefiningElement
SubstancePolymer_StartingMaterialamountTodo.SubstanceAmount
SubstancePolymer_StructuralRepresentationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstancePolymer_StructuralRepresentationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_StructuralRepresentationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_StructuralRepresentationtypeTodo.CodeableConcept
SubstancePolymer_StructuralRepresentationrepresentationTodo.string
SubstancePolymer_StructuralRepresentation_representationExtensions for representationElement
SubstancePolymer_StructuralRepresentationformatTodo.CodeableConcept
SubstancePolymer_StructuralRepresentationattachmentTodo.Attachment
SubstanceProteinresourceTypeThis is a SubstanceProtein resourceSubstanceProtein
SubstanceProteinidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubstanceProteinmetaThe metadata about the resource. 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
SubstanceProteinimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SubstanceProteinlanguageThe base language in which the resource is written.code
SubstanceProtein_languageExtensions for languageElement
SubstanceProteintextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubstanceProteincontainedThese 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
SubstanceProteinextensionMay be 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
SubstanceProteinmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubstanceProteinsequenceTypeThe 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
SubstanceProteinnumberOfSubunitsNumber 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_numberOfSubunitsExtensions for numberOfSubunitsElement
SubstanceProteindisulfideLinkageThe 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_disulfideLinkageExtensions for disulfideLinkageElement
SubstanceProteinsubunitThis 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_SubunitidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceProtein_SubunitextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SubunitmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SubunitsubunitIndex 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_subunitExtensions for subunitElement
SubstanceProtein_SubunitsequenceThe 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_sequenceExtensions for sequenceElement
SubstanceProtein_SubunitlengthLength of linear sequences of amino acids contained in the subunit.integer
SubstanceProtein_Subunit_lengthExtensions for lengthElement
SubstanceProtein_SubunitsequenceAttachmentThe 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_SubunitnTerminalModificationIdUnique identifier for molecular fragment modification based on the ISO 11238 Substance ID.Identifier
SubstanceProtein_SubunitnTerminalModificationThe name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.string
SubstanceProtein_Subunit_nTerminalModificationExtensions for nTerminalModificationElement
SubstanceProtein_SubunitcTerminalModificationIdUnique identifier for molecular fragment modification based on the ISO 11238 Substance ID.Identifier
SubstanceProtein_SubunitcTerminalModificationThe modification at the C-terminal shall be specified.string
SubstanceProtein_Subunit_cTerminalModificationExtensions for cTerminalModificationElement
SubstanceReferenceInformationresourceTypeThis is a SubstanceReferenceInformation resourceSubstanceReferenceInformation
SubstanceReferenceInformationidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubstanceReferenceInformationmetaThe metadata about the resource. 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
SubstanceReferenceInformationimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SubstanceReferenceInformationlanguageThe base language in which the resource is written.code
SubstanceReferenceInformation_languageExtensions for languageElement
SubstanceReferenceInformationtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubstanceReferenceInformationcontainedThese 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
SubstanceReferenceInformationextensionMay be 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
SubstanceReferenceInformationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubstanceReferenceInformationcommentTodo.string
SubstanceReferenceInformation_commentExtensions for commentElement
SubstanceReferenceInformationgeneTodo.SubstanceReferenceInformation_Gene
SubstanceReferenceInformationgeneElementTodo.SubstanceReferenceInformation_GeneElement
SubstanceReferenceInformationclassificationTodo.SubstanceReferenceInformation_Classification
SubstanceReferenceInformationtargetTodo.SubstanceReferenceInformation_Target
SubstanceReferenceInformation_ClassificationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceReferenceInformation_ClassificationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ClassificationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ClassificationdomainTodo.CodeableConcept
SubstanceReferenceInformation_ClassificationclassificationTodo.CodeableConcept
SubstanceReferenceInformation_ClassificationsubtypeTodo.CodeableConcept
SubstanceReferenceInformation_ClassificationsourceTodo.Reference
SubstanceReferenceInformation_GeneidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceReferenceInformation_GeneextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GenemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GenegeneSequenceOriginTodo.CodeableConcept
SubstanceReferenceInformation_GenegeneTodo.CodeableConcept
SubstanceReferenceInformation_GenesourceTodo.Reference
SubstanceReferenceInformation_GeneElementidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceReferenceInformation_GeneElementextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_GeneElementmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_GeneElementtypeTodo.CodeableConcept
SubstanceReferenceInformation_GeneElementelementTodo.Identifier
SubstanceReferenceInformation_GeneElementsourceTodo.Reference
SubstanceReferenceInformation_TargetidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceReferenceInformation_TargetextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TargetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TargettargetTodo.Identifier
SubstanceReferenceInformation_TargettypeTodo.CodeableConcept
SubstanceReferenceInformation_TargetinteractionTodo.CodeableConcept
SubstanceReferenceInformation_TargetorganismTodo.CodeableConcept
SubstanceReferenceInformation_TargetorganismTypeTodo.CodeableConcept
SubstanceReferenceInformation_TargetamountQuantityTodo.Quantity
SubstanceReferenceInformation_TargetamountRangeTodo.Range
SubstanceReferenceInformation_TargetamountStringTodo.notDefined
SubstanceReferenceInformation_Target_amountStringExtensions for amountStringElement
SubstanceReferenceInformation_TargetamountTypeTodo.CodeableConcept
SubstanceReferenceInformation_TargetsourceTodo.Reference
SubstanceSourceMaterialresourceTypeThis is a SubstanceSourceMaterial resourceSubstanceSourceMaterial
SubstanceSourceMaterialidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SubstanceSourceMaterialmetaThe metadata about the resource. 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
SubstanceSourceMaterialimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SubstanceSourceMateriallanguageThe base language in which the resource is written.code
SubstanceSourceMaterial_languageExtensions for languageElement
SubstanceSourceMaterialtextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SubstanceSourceMaterialcontainedThese 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
SubstanceSourceMaterialextensionMay be 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
SubstanceSourceMaterialmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SubstanceSourceMaterialsourceMaterialClassGeneral high level classification of the source material specific to the origin of the material.CodeableConcept
SubstanceSourceMaterialsourceMaterialTypeThe 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
SubstanceSourceMaterialsourceMaterialStateThe state of the source material when extracted.CodeableConcept
SubstanceSourceMaterialorganismIdThe unique identifier associated with the source material parent organism shall be specified.Identifier
SubstanceSourceMaterialorganismNameThe organism accepted Scientific name shall be provided based on the organism taxonomy.string
SubstanceSourceMaterial_organismNameExtensions for organismNameElement
SubstanceSourceMaterialparentSubstanceIdThe 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
SubstanceSourceMaterialparentSubstanceNameThe parent substance of the Herbal Drug, or Herbal preparation.string
SubstanceSourceMaterial_parentSubstanceNameExtensions for parentSubstanceNameElement
SubstanceSourceMaterialcountryOfOriginThe 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
SubstanceSourceMaterialgeographicalLocationThe place/region where the plant is harvested or the places/regions where the animal source material has its habitat.string
SubstanceSourceMaterial_geographicalLocationExtensions for geographicalLocationElement
SubstanceSourceMaterialdevelopmentStageStage 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
SubstanceSourceMaterialfractionDescriptionMany 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
SubstanceSourceMaterialorganismThis 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
SubstanceSourceMaterialpartDescriptionTo do.SubstanceSourceMaterial_PartDescription
SubstanceSourceMaterial_AuthoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceSourceMaterial_AuthorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AuthormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AuthorauthorTypeThe 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_AuthorauthorDescriptionThe 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_authorDescriptionExtensions for authorDescriptionElement
SubstanceSourceMaterial_FractionDescriptionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceSourceMaterial_FractionDescriptionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FractionDescriptionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FractionDescriptionfractionThis element is capturing information about the fraction of a plant part, or human plasma for fractionation.string
SubstanceSourceMaterial_FractionDescription_fractionExtensions for fractionElement
SubstanceSourceMaterial_FractionDescriptionmaterialTypeThe 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_HybrididUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceSourceMaterial_HybridextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_HybridmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_HybridmaternalOrganismIdThe 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_maternalOrganismIdExtensions for maternalOrganismIdElement
SubstanceSourceMaterial_HybridmaternalOrganismNameThe 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_maternalOrganismNameExtensions for maternalOrganismNameElement
SubstanceSourceMaterial_HybridpaternalOrganismIdThe identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.string
SubstanceSourceMaterial_Hybrid_paternalOrganismIdExtensions for paternalOrganismIdElement
SubstanceSourceMaterial_HybridpaternalOrganismNameThe name of the paternal species constituting the hybrid organism shall be specified.string
SubstanceSourceMaterial_Hybrid_paternalOrganismNameExtensions for paternalOrganismNameElement
SubstanceSourceMaterial_HybridhybridTypeThe hybrid type of an organism shall be specified.CodeableConcept
SubstanceSourceMaterial_OrganismidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceSourceMaterial_OrganismextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OrganismmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OrganismfamilyThe family of an organism shall be specified.CodeableConcept
SubstanceSourceMaterial_OrganismgenusThe 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_OrganismspeciesThe 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_OrganismintraspecificTypeThe Intraspecific type of an organism shall be specified.CodeableConcept
SubstanceSourceMaterial_OrganismintraspecificDescriptionThe 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_intraspecificDescriptionExtensions for intraspecificDescriptionElement
SubstanceSourceMaterial_Organismauthor4.9.13.6.1 Author type (Conditional).SubstanceSourceMaterial_Author
SubstanceSourceMaterial_Organismhybrid4.9.13.8.1 Hybrid species maternal organism ID (Optional).SubstanceSourceMaterial_Hybrid
SubstanceSourceMaterial_OrganismorganismGeneral4.9.13.7.1 Kingdom (Conditional).SubstanceSourceMaterial_OrganismGeneral
SubstanceSourceMaterial_OrganismGeneralidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceSourceMaterial_OrganismGeneralextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OrganismGeneralmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OrganismGeneralkingdomThe kingdom of an organism shall be specified.CodeableConcept
SubstanceSourceMaterial_OrganismGeneralphylumThe phylum of an organism shall be specified.CodeableConcept
SubstanceSourceMaterial_OrganismGeneralclassThe class of an organism shall be specified.CodeableConcept
SubstanceSourceMaterial_OrganismGeneralorderThe order of an organism shall be specified,.CodeableConcept
SubstanceSourceMaterial_PartDescriptionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SubstanceSourceMaterial_PartDescriptionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PartDescriptionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PartDescriptionpartEntity of anatomical origin of source material within an organism.CodeableConcept
SubstanceSourceMaterial_PartDescriptionpartLocationThe detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.CodeableConcept
Substance_IngredientidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Substance_IngredientextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_IngredientmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_IngredientquantityThe amount of the ingredient in the substance - a concentration ratio.Ratio
Substance_IngredientsubstanceCodeableConceptAnother substance that is a component of this substance.CodeableConcept
Substance_IngredientsubstanceReferenceAnother substance that is a component of this substance.Reference
Substance_InstanceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Substance_InstanceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InstancemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InstanceidentifierIdentifier associated with the package/container (usually a label affixed directly).Identifier
Substance_InstanceexpiryWhen the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.dateTime
Substance_Instance_expiryExtensions for expiryElement
Substance_InstancequantityThe amount of the substance.Quantity
SupplyDeliveryresourceTypeThis is a SupplyDelivery resourceSupplyDelivery
SupplyDeliveryidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SupplyDeliverymetaThe metadata about the resource. 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
SupplyDeliveryimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SupplyDeliverylanguageThe base language in which the resource is written.code
SupplyDelivery_languageExtensions for languageElement
SupplyDeliverytextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SupplyDeliverycontainedThese 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
SupplyDeliveryextensionMay be 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
SupplyDeliverymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SupplyDeliveryidentifierIdentifier for the supply delivery event that is used to identify it across multiple disparate systems.Identifier
SupplyDeliverybasedOnA plan, proposal or order that is fulfilled in whole or in part by this event.Reference
SupplyDeliverypartOfA larger event of which this particular event is a component or step.Reference
SupplyDeliverystatusA code specifying the state of the dispense event.enum values:
in-progress
completed
abandoned
entered-in-error
SupplyDelivery_statusExtensions for statusElement
SupplyDeliverypatientA link to a resource representing the person whom the delivered item is for.Reference
SupplyDeliverytypeIndicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.CodeableConcept
SupplyDeliverysuppliedItemThe item that is being delivered or has been supplied.SupplyDelivery_SuppliedItem
SupplyDeliveryoccurrenceDateTimeThe date or time(s) the activity occurred.notDefined
SupplyDelivery_occurrenceDateTimeExtensions for occurrenceDateTimeElement
SupplyDeliveryoccurrencePeriodThe date or time(s) the activity occurred.Period
SupplyDeliveryoccurrenceTimingThe date or time(s) the activity occurred.Timing
SupplyDeliverysupplierThe individual responsible for dispensing the medication, supplier or device.Reference
SupplyDeliverydestinationIdentification of the facility/location where the Supply was shipped to, as part of the dispense event.Reference
SupplyDeliveryreceiverIdentifies the person who picked up the Supply.Reference
SupplyDelivery_SuppliedItemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SupplyDelivery_SuppliedItemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SuppliedItemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SuppliedItemquantityThe amount of supply that has been dispensed. Includes unit of measure.Quantity
SupplyDelivery_SuppliedItemitemCodeableConceptIdentifies 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_SuppliedItemitemReferenceIdentifies 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
SupplyRequestresourceTypeThis is a SupplyRequest resourceSupplyRequest
SupplyRequestidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
SupplyRequestmetaThe metadata about the resource. 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
SupplyRequestimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
SupplyRequestlanguageThe base language in which the resource is written.code
SupplyRequest_languageExtensions for languageElement
SupplyRequesttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
SupplyRequestcontainedThese 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
SupplyRequestextensionMay be 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
SupplyRequestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
SupplyRequestidentifierBusiness 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
SupplyRequeststatusStatus of the supply request.enum values:
draft
active
suspended
cancelled
completed
entered-in-error
unknown
SupplyRequest_statusExtensions for statusElement
SupplyRequestcategoryCategory of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.CodeableConcept
SupplyRequestpriorityIndicates how quickly this SupplyRequest should be addressed with respect to other requests.code
SupplyRequest_priorityExtensions for priorityElement
SupplyRequestitemThe 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.CodeableReference
SupplyRequestquantityThe amount that is being ordered of the indicated item.Quantity
SupplyRequestparameterSpecific parameters for the ordered item. For example, the size of the indicated item.SupplyRequest_Parameter
SupplyRequestoccurrenceDateTimeWhen the request should be fulfilled.notDefined
SupplyRequest_occurrenceDateTimeExtensions for occurrenceDateTimeElement
SupplyRequestoccurrencePeriodWhen the request should be fulfilled.Period
SupplyRequestoccurrenceTimingWhen the request should be fulfilled.Timing
SupplyRequestauthoredOnWhen the request was made.dateTime
SupplyRequest_authoredOnExtensions for authoredOnElement
SupplyRequestrequesterThe device, practitioner, etc. who initiated the request.Reference
SupplyRequestsupplierWho is intended to fulfill the request.Reference
SupplyRequestreasonThe reason why the supply item was requested.CodeableReference
SupplyRequestdeliverFromWhere the supply is expected to come from.Reference
SupplyRequestdeliverToWhere the supply is destined to go.Reference
SupplyRequest_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
SupplyRequest_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParametercodeA code or string that identifies the device detail being asserted.CodeableConcept
SupplyRequest_ParametervalueCodeableConceptThe value of the device detail.CodeableConcept
SupplyRequest_ParametervalueQuantityThe value of the device detail.Quantity
SupplyRequest_ParametervalueRangeThe value of the device detail.Range
SupplyRequest_ParametervalueBooleanThe value of the device detail.notDefined
SupplyRequest_Parameter_valueBooleanExtensions for valueBooleanElement
TaskresourceTypeThis is a Task resourceTask
TaskidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
TaskmetaThe metadata about the resource. 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
TaskimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
TasklanguageThe base language in which the resource is written.code
Task_languageExtensions for languageElement
TasktextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
TaskcontainedThese 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
TaskextensionMay be 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
TaskmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
TaskidentifierThe business identifier for this task.Identifier
TaskinstantiatesCanonicalThe 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
TaskinstantiatesUriThe 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_instantiatesUriExtensions for instantiatesUriElement
TaskbasedOnBasedOn 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
TaskgroupIdentifierAn identifier that links together multiple tasks and other requests that were created in the same context.Identifier
TaskpartOfTask that this particular task is part of.Reference
TaskstatusThe current status of the task.enum values:
draft
requested
received
accepted
rejected
ready
cancelled
in-progress
on-hold
failed
completed
entered-in-error
Task_statusExtensions for statusElement
TaskstatusReasonAn explanation as to why this task is held, failed, was refused, etc.CodeableConcept
TaskbusinessStatusContains business-specific nuances of the business state.CodeableConcept
TaskintentIndicates 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_intentExtensions for intentElement
TaskpriorityIndicates how quickly the Task should be addressed with respect to other requests.code
Task_priorityExtensions for priorityElement
TaskcodeA name or code (or both) briefly describing what the task involves.CodeableConcept
TaskdescriptionA free-text description of what is to be performed.string
Task_descriptionExtensions for descriptionElement
TaskfocusThe request being actioned or the resource being manipulated by this task.Reference
TaskforThe entity who benefits from the performance of the service specified in the task (e.g., the patient).Reference
TaskencounterThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.Reference
TaskexecutionPeriodIdentifies 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
TaskauthoredOnThe date and time this task was created.dateTime
Task_authoredOnExtensions for authoredOnElement
TasklastModifiedThe date and time of last modification to this task.dateTime
Task_lastModifiedExtensions for lastModifiedElement
TaskrequesterThe creator of the task.Reference
TaskperformerTypeThe kind of participant that should perform the task.CodeableConcept
TaskownerIndividual organization or Device currently responsible for task execution.Reference
TasklocationPrincipal physical location where the this task is performed.Reference
TaskreasonCodeA description or code indicating why this task needs to be performed.CodeableConcept
TaskreasonReferenceA resource reference indicating why this task needs to be performed.Reference
TaskinsuranceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.Reference
TasknoteFree-text information captured about the task as it progresses.Annotation
TaskrelevantHistoryLinks 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
TaskrestrictionIf 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
TaskinputAdditional information that may be needed in the execution of the task.Task_Input
TaskoutputOutputs produced by the Task.Task_Output
Task_InputidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Task_InputextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_InputmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_InputtypeA code or description indicating how the input is intended to be used as part of the task execution.CodeableConcept
Task_InputvalueBase64BinaryThe value of the input parameter as a basic type.notDefined
Task_Input_valueBase64BinaryExtensions for valueBase64BinaryElement
Task_InputvalueBooleanThe value of the input parameter as a basic type.notDefined
Task_Input_valueBooleanExtensions for valueBooleanElement
Task_InputvalueCanonicalThe value of the input parameter as a basic type.notDefined
Task_Input_valueCanonicalExtensions for valueCanonicalElement
Task_InputvalueCodeThe value of the input parameter as a basic type.notDefined
Task_Input_valueCodeExtensions for valueCodeElement
Task_InputvalueDateThe value of the input parameter as a basic type.notDefined
Task_Input_valueDateExtensions for valueDateElement
Task_InputvalueDateTimeThe value of the input parameter as a basic type.notDefined
Task_Input_valueDateTimeExtensions for valueDateTimeElement
Task_InputvalueDecimalThe value of the input parameter as a basic type.notDefined
Task_Input_valueDecimalExtensions for valueDecimalElement
Task_InputvalueIdThe value of the input parameter as a basic type.notDefined
Task_Input_valueIdExtensions for valueIdElement
Task_InputvalueInstantThe value of the input parameter as a basic type.notDefined
Task_Input_valueInstantExtensions for valueInstantElement
Task_InputvalueIntegerThe value of the input parameter as a basic type.notDefined
Task_Input_valueIntegerExtensions for valueIntegerElement
Task_InputvalueInteger64The value of the input parameter as a basic type.notDefined
Task_Input_valueInteger64Extensions for valueInteger64Element
Task_InputvalueMarkdownThe value of the input parameter as a basic type.notDefined
Task_Input_valueMarkdownExtensions for valueMarkdownElement
Task_InputvalueOidThe value of the input parameter as a basic type.notDefined
Task_Input_valueOidExtensions for valueOidElement
Task_InputvaluePositiveIntThe value of the input parameter as a basic type.notDefined
Task_Input_valuePositiveIntExtensions for valuePositiveIntElement
Task_InputvalueStringThe value of the input parameter as a basic type.notDefined
Task_Input_valueStringExtensions for valueStringElement
Task_InputvalueTimeThe value of the input parameter as a basic type.notDefined
Task_Input_valueTimeExtensions for valueTimeElement
Task_InputvalueUnsignedIntThe value of the input parameter as a basic type.notDefined
Task_Input_valueUnsignedIntExtensions for valueUnsignedIntElement
Task_InputvalueUriThe value of the input parameter as a basic type.notDefined
Task_Input_valueUriExtensions for valueUriElement
Task_InputvalueUrlThe value of the input parameter as a basic type.notDefined
Task_Input_valueUrlExtensions for valueUrlElement
Task_InputvalueUuidThe value of the input parameter as a basic type.notDefined
Task_Input_valueUuidExtensions for valueUuidElement
Task_InputvalueAddressThe value of the input parameter as a basic type.Address
Task_InputvalueAgeThe value of the input parameter as a basic type.Age
Task_InputvalueAnnotationThe value of the input parameter as a basic type.Annotation
Task_InputvalueAttachmentThe value of the input parameter as a basic type.Attachment
Task_InputvalueCodeableConceptThe value of the input parameter as a basic type.CodeableConcept
Task_InputvalueCodingThe value of the input parameter as a basic type.Coding
Task_InputvalueContactPointThe value of the input parameter as a basic type.ContactPoint
Task_InputvalueCountThe value of the input parameter as a basic type.Count
Task_InputvalueDistanceThe value of the input parameter as a basic type.Distance
Task_InputvalueDurationThe value of the input parameter as a basic type.Duration
Task_InputvalueHumanNameThe value of the input parameter as a basic type.HumanName
Task_InputvalueIdentifierThe value of the input parameter as a basic type.Identifier
Task_InputvalueMoneyThe value of the input parameter as a basic type.Money
Task_InputvaluePeriodThe value of the input parameter as a basic type.Period
Task_InputvalueQuantityThe value of the input parameter as a basic type.Quantity
Task_InputvalueRangeThe value of the input parameter as a basic type.Range
Task_InputvalueRatioThe value of the input parameter as a basic type.Ratio
Task_InputvalueReferenceThe value of the input parameter as a basic type.Reference
Task_InputvalueSampledDataThe value of the input parameter as a basic type.SampledData
Task_InputvalueSignatureThe value of the input parameter as a basic type.Signature
Task_InputvalueTimingThe value of the input parameter as a basic type.Timing
Task_InputvalueContactDetailThe value of the input parameter as a basic type.ContactDetail
Task_InputvalueContributorThe value of the input parameter as a basic type.Contributor
Task_InputvalueDataRequirementThe value of the input parameter as a basic type.DataRequirement
Task_InputvalueExpressionThe value of the input parameter as a basic type.Expression
Task_InputvalueParameterDefinitionThe value of the input parameter as a basic type.ParameterDefinition
Task_InputvalueRelatedArtifactThe value of the input parameter as a basic type.RelatedArtifact
Task_InputvalueTriggerDefinitionThe value of the input parameter as a basic type.TriggerDefinition
Task_InputvalueUsageContextThe value of the input parameter as a basic type.UsageContext
Task_InputvalueDosageThe value of the input parameter as a basic type.Dosage
Task_InputvalueMetaThe value of the input parameter as a basic type.Meta
Task_OutputidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Task_OutputextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OutputmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OutputtypeThe name of the Output parameter.CodeableConcept
Task_OutputvalueBase64BinaryThe value of the Output parameter as a basic type.notDefined
Task_Output_valueBase64BinaryExtensions for valueBase64BinaryElement
Task_OutputvalueBooleanThe value of the Output parameter as a basic type.notDefined
Task_Output_valueBooleanExtensions for valueBooleanElement
Task_OutputvalueCanonicalThe value of the Output parameter as a basic type.notDefined
Task_Output_valueCanonicalExtensions for valueCanonicalElement
Task_OutputvalueCodeThe value of the Output parameter as a basic type.notDefined
Task_Output_valueCodeExtensions for valueCodeElement
Task_OutputvalueDateThe value of the Output parameter as a basic type.notDefined
Task_Output_valueDateExtensions for valueDateElement
Task_OutputvalueDateTimeThe value of the Output parameter as a basic type.notDefined
Task_Output_valueDateTimeExtensions for valueDateTimeElement
Task_OutputvalueDecimalThe value of the Output parameter as a basic type.notDefined
Task_Output_valueDecimalExtensions for valueDecimalElement
Task_OutputvalueIdThe value of the Output parameter as a basic type.notDefined
Task_Output_valueIdExtensions for valueIdElement
Task_OutputvalueInstantThe value of the Output parameter as a basic type.notDefined
Task_Output_valueInstantExtensions for valueInstantElement
Task_OutputvalueIntegerThe value of the Output parameter as a basic type.notDefined
Task_Output_valueIntegerExtensions for valueIntegerElement
Task_OutputvalueInteger64The value of the Output parameter as a basic type.notDefined
Task_Output_valueInteger64Extensions for valueInteger64Element
Task_OutputvalueMarkdownThe value of the Output parameter as a basic type.notDefined
Task_Output_valueMarkdownExtensions for valueMarkdownElement
Task_OutputvalueOidThe value of the Output parameter as a basic type.notDefined
Task_Output_valueOidExtensions for valueOidElement
Task_OutputvaluePositiveIntThe value of the Output parameter as a basic type.notDefined
Task_Output_valuePositiveIntExtensions for valuePositiveIntElement
Task_OutputvalueStringThe value of the Output parameter as a basic type.notDefined
Task_Output_valueStringExtensions for valueStringElement
Task_OutputvalueTimeThe value of the Output parameter as a basic type.notDefined
Task_Output_valueTimeExtensions for valueTimeElement
Task_OutputvalueUnsignedIntThe value of the Output parameter as a basic type.notDefined
Task_Output_valueUnsignedIntExtensions for valueUnsignedIntElement
Task_OutputvalueUriThe value of the Output parameter as a basic type.notDefined
Task_Output_valueUriExtensions for valueUriElement
Task_OutputvalueUrlThe value of the Output parameter as a basic type.notDefined
Task_Output_valueUrlExtensions for valueUrlElement
Task_OutputvalueUuidThe value of the Output parameter as a basic type.notDefined
Task_Output_valueUuidExtensions for valueUuidElement
Task_OutputvalueAddressThe value of the Output parameter as a basic type.Address
Task_OutputvalueAgeThe value of the Output parameter as a basic type.Age
Task_OutputvalueAnnotationThe value of the Output parameter as a basic type.Annotation
Task_OutputvalueAttachmentThe value of the Output parameter as a basic type.Attachment
Task_OutputvalueCodeableConceptThe value of the Output parameter as a basic type.CodeableConcept
Task_OutputvalueCodingThe value of the Output parameter as a basic type.Coding
Task_OutputvalueContactPointThe value of the Output parameter as a basic type.ContactPoint
Task_OutputvalueCountThe value of the Output parameter as a basic type.Count
Task_OutputvalueDistanceThe value of the Output parameter as a basic type.Distance
Task_OutputvalueDurationThe value of the Output parameter as a basic type.Duration
Task_OutputvalueHumanNameThe value of the Output parameter as a basic type.HumanName
Task_OutputvalueIdentifierThe value of the Output parameter as a basic type.Identifier
Task_OutputvalueMoneyThe value of the Output parameter as a basic type.Money
Task_OutputvaluePeriodThe value of the Output parameter as a basic type.Period
Task_OutputvalueQuantityThe value of the Output parameter as a basic type.Quantity
Task_OutputvalueRangeThe value of the Output parameter as a basic type.Range
Task_OutputvalueRatioThe value of the Output parameter as a basic type.Ratio
Task_OutputvalueReferenceThe value of the Output parameter as a basic type.Reference
Task_OutputvalueSampledDataThe value of the Output parameter as a basic type.SampledData
Task_OutputvalueSignatureThe value of the Output parameter as a basic type.Signature
Task_OutputvalueTimingThe value of the Output parameter as a basic type.Timing
Task_OutputvalueContactDetailThe value of the Output parameter as a basic type.ContactDetail
Task_OutputvalueContributorThe value of the Output parameter as a basic type.Contributor
Task_OutputvalueDataRequirementThe value of the Output parameter as a basic type.DataRequirement
Task_OutputvalueExpressionThe value of the Output parameter as a basic type.Expression
Task_OutputvalueParameterDefinitionThe value of the Output parameter as a basic type.ParameterDefinition
Task_OutputvalueRelatedArtifactThe value of the Output parameter as a basic type.RelatedArtifact
Task_OutputvalueTriggerDefinitionThe value of the Output parameter as a basic type.TriggerDefinition
Task_OutputvalueUsageContextThe value of the Output parameter as a basic type.UsageContext
Task_OutputvalueDosageThe value of the Output parameter as a basic type.Dosage
Task_OutputvalueMetaThe value of the Output parameter as a basic type.Meta
Task_RestrictionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Task_RestrictionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RestrictionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RestrictionrepetitionsIndicates the number of times the requested action should occur.positiveInt
Task_Restriction_repetitionsExtensions for repetitionsElement
Task_RestrictionperiodOver what time-period is fulfillment sought.Period
Task_RestrictionrecipientFor requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?Reference
TerminologyCapabilitiesresourceTypeThis is a TerminologyCapabilities resourceTerminologyCapabilities
TerminologyCapabilitiesidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
TerminologyCapabilitiesmetaThe metadata about the resource. 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
TerminologyCapabilitiesimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
TerminologyCapabilitieslanguageThe base language in which the resource is written.code
TerminologyCapabilities_languageExtensions for languageElement
TerminologyCapabilitiestextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
TerminologyCapabilitiescontainedThese 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
TerminologyCapabilitiesextensionMay be 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
TerminologyCapabilitiesmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
TerminologyCapabilitiesurlAn 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_urlExtensions for urlElement
TerminologyCapabilitiesidentifierA formal identifier that is used to identify this terminology capabilities when it is represented in other formats, or referenced in a specification, model, design or an instance.Identifier
TerminologyCapabilitiesversionThe 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_versionExtensions for versionElement
TerminologyCapabilitiesnameA 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_nameExtensions for nameElement
TerminologyCapabilitiestitleA short, descriptive, user-friendly title for the terminology capabilities.string
TerminologyCapabilities_titleExtensions for titleElement
TerminologyCapabilitiesstatusThe status of this terminology capabilities. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
TerminologyCapabilities_statusExtensions for statusElement
TerminologyCapabilitiesexperimentalA 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_experimentalExtensions for experimentalElement
TerminologyCapabilitiesdateThe 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_dateExtensions for dateElement
TerminologyCapabilitiespublisherThe name of the organization or individual that published the terminology capabilities.string
TerminologyCapabilities_publisherExtensions for publisherElement
TerminologyCapabilitiescontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
TerminologyCapabilitiesdescriptionA 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_descriptionExtensions for descriptionElement
TerminologyCapabilitiesuseContextThe 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
TerminologyCapabilitiesjurisdictionA legal or geographic region in which the terminology capabilities is intended to be used.CodeableConcept
TerminologyCapabilitiespurposeExplanation of why this terminology capabilities is needed and why it has been designed as it has.markdown
TerminologyCapabilities_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
TerminologyCapabilitieskindThe 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_kindExtensions for kindElement
TerminologyCapabilitiessoftwareSoftware 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
TerminologyCapabilitiesimplementationIdentifies 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
TerminologyCapabilitieslockedDateWhether the server supports lockedDate.boolean
TerminologyCapabilities_lockedDateExtensions for lockedDateElement
TerminologyCapabilitiescodeSystemIdentifies 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
TerminologyCapabilitiesexpansionInformation about the [ValueSet/$expand](valueset-operation-expand.html) operation.TerminologyCapabilities_Expansion
TerminologyCapabilitiescodeSearchThe degree to which the server supports the code search parameter on ValueSet, if it is supported.enum values:
explicit
all
TerminologyCapabilities_codeSearchExtensions for codeSearchElement
TerminologyCapabilitiesvalidateCodeInformation about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.TerminologyCapabilities_ValidateCode
TerminologyCapabilitiestranslationInformation about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.TerminologyCapabilities_Translation
TerminologyCapabilitiesclosureWhether the $closure operation is supported.TerminologyCapabilities_Closure
TerminologyCapabilities_ClosureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_ClosureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ClosuremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ClosuretranslationIf cross-system closure is supported.boolean
TerminologyCapabilities_Closure_translationExtensions for translationElement
TerminologyCapabilities_CodeSystemidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_CodeSystemextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CodeSystemmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CodeSystemuriURI for the Code System.canonical
TerminologyCapabilities_CodeSystemversionFor the code system, a list of versions that are supported by the server.TerminologyCapabilities_Version
TerminologyCapabilities_CodeSystemsubsumptionTrue if subsumption is supported for this version of the code system.boolean
TerminologyCapabilities_CodeSystem_subsumptionExtensions for subsumptionElement
TerminologyCapabilities_ExpansionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_ExpansionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ExpansionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ExpansionhierarchicalWhether the server can return nested value sets.boolean
TerminologyCapabilities_Expansion_hierarchicalExtensions for hierarchicalElement
TerminologyCapabilities_ExpansionpagingWhether the server supports paging on expansion.boolean
TerminologyCapabilities_Expansion_pagingExtensions for pagingElement
TerminologyCapabilities_ExpansionincompleteAllow request for incomplete expansions?boolean
TerminologyCapabilities_Expansion_incompleteExtensions for incompleteElement
TerminologyCapabilities_ExpansionparameterSupported expansion parameter.TerminologyCapabilities_Parameter
TerminologyCapabilities_ExpansiontextFilterDocumentation about text searching works.markdown
TerminologyCapabilities_Expansion_textFilterExtensions for textFilterElement
TerminologyCapabilities_FilteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_FilterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FiltermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FiltercodeCode of the property supported.code
TerminologyCapabilities_Filter_codeExtensions for codeElement
TerminologyCapabilities_FilteropOperations supported for the property.code
TerminologyCapabilities_Filter_opExtensions for opElement
TerminologyCapabilities_ImplementationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_ImplementationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ImplementationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ImplementationdescriptionInformation about the specific installation that this terminology capability statement relates to.string
TerminologyCapabilities_Implementation_descriptionExtensions for descriptionElement
TerminologyCapabilities_ImplementationurlAn absolute base URL for the implementation.url
TerminologyCapabilities_Implementation_urlExtensions for urlElement
TerminologyCapabilities_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParameternameExpansion Parameter name.code
TerminologyCapabilities_Parameter_nameExtensions for nameElement
TerminologyCapabilities_ParameterdocumentationDescription of support for parameter.string
TerminologyCapabilities_Parameter_documentationExtensions for documentationElement
TerminologyCapabilities_SoftwareidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_SoftwareextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SoftwaremodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SoftwarenameName the software is known by.string
TerminologyCapabilities_Software_nameExtensions for nameElement
TerminologyCapabilities_SoftwareversionThe version identifier for the software covered by this statement.string
TerminologyCapabilities_Software_versionExtensions for versionElement
TerminologyCapabilities_TranslationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_TranslationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TranslationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TranslationneedsMapWhether the client must identify the map.boolean
TerminologyCapabilities_Translation_needsMapExtensions for needsMapElement
TerminologyCapabilities_ValidateCodeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_ValidateCodeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ValidateCodemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ValidateCodetranslationsWhether translations are validated.boolean
TerminologyCapabilities_ValidateCode_translationsExtensions for translationsElement
TerminologyCapabilities_VersionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TerminologyCapabilities_VersionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_VersionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_VersioncodeFor version-less code systems, there should be a single version with no identifier.string
TerminologyCapabilities_Version_codeExtensions for codeElement
TerminologyCapabilities_VersionisDefaultIf this is the default version for this code system.boolean
TerminologyCapabilities_Version_isDefaultExtensions for isDefaultElement
TerminologyCapabilities_VersioncompositionalIf the compositional grammar defined by the code system is supported.boolean
TerminologyCapabilities_Version_compositionalExtensions for compositionalElement
TerminologyCapabilities_VersionlanguageLanguage Displays supported.code
TerminologyCapabilities_Version_languageExtensions for languageElement
TerminologyCapabilities_VersionfilterFilter Properties supported.TerminologyCapabilities_Filter
TerminologyCapabilities_VersionpropertyProperties supported for $lookup.code
TerminologyCapabilities_Version_propertyExtensions for propertyElement
TestReportresourceTypeThis is a TestReport resourceTestReport
TestReportidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
TestReportmetaThe metadata about the resource. 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
TestReportimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
TestReportlanguageThe base language in which the resource is written.code
TestReport_languageExtensions for languageElement
TestReporttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
TestReportcontainedThese 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
TestReportextensionMay be 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
TestReportmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
TestReportidentifierIdentifier for the TestScript assigned for external purposes outside the context of FHIR.Identifier
TestReportnameA free text natural language name identifying the executed TestScript.string
TestReport_nameExtensions for nameElement
TestReportstatusThe current state of this test report.enum values:
completed
in-progress
waiting
stopped
entered-in-error
TestReport_statusExtensions for statusElement
TestReporttestScriptIdeally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.Reference
TestReportresultThe overall result from the execution of the TestScript.enum values:
pass
fail
pending
TestReport_resultExtensions for resultElement
TestReportscoreThe final score (percentage of tests passed) resulting from the execution of the TestScript.decimal
TestReport_scoreExtensions for scoreElement
TestReporttesterName of the tester producing this report (Organization or individual).string
TestReport_testerExtensions for testerElement
TestReportissuedWhen the TestScript was executed and this TestReport was generated.dateTime
TestReport_issuedExtensions for issuedElement
TestReportparticipantA participant in the test execution, either the execution engine, a client, or a server.TestReport_Participant
TestReportsetupThe results of the series of required setup operations before the tests were executed.TestReport_Setup
TestReporttestA test executed from the test script.TestReport_Test
TestReportteardownThe results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).TestReport_Teardown
TestReport_ActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_ActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ActionoperationThe operation performed.TestReport_Operation
TestReport_ActionassertThe results of the assertion performed on the previous operations.TestReport_Assert
TestReport_Action1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_Action1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Action1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Action1operationAn operation would involve a REST request to a server.TestReport_Operation
TestReport_Action1assertThe results of the assertion performed on the previous operations.TestReport_Assert
TestReport_Action2idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_Action2extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Action2modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Action2operationAn operation would involve a REST request to a server.TestReport_Operation
TestReport_AssertidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_AssertextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AssertmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AssertresultThe result of this assertion.enum values:
pass
skip
fail
warning
error
TestReport_Assert_resultExtensions for resultElement
TestReport_AssertmessageAn explanatory message associated with the result.markdown
TestReport_Assert_messageExtensions for messageElement
TestReport_AssertdetailA link to further details on the result.string
TestReport_Assert_detailExtensions for detailElement
TestReport_OperationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_OperationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OperationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OperationresultThe result of this operation.enum values:
pass
skip
fail
warning
error
TestReport_Operation_resultExtensions for resultElement
TestReport_OperationmessageAn explanatory message associated with the result.markdown
TestReport_Operation_messageExtensions for messageElement
TestReport_OperationdetailA link to further details on the result.uri
TestReport_Operation_detailExtensions for detailElement
TestReport_ParticipantidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_ParticipantextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParticipantmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParticipanttypeThe type of participant.enum values:
test-engine
client
server
TestReport_Participant_typeExtensions for typeElement
TestReport_ParticipanturiThe uri of the participant. An absolute URL is preferred.uri
TestReport_Participant_uriExtensions for uriElement
TestReport_ParticipantdisplayThe display name of the participant.string
TestReport_Participant_displayExtensions for displayElement
TestReport_SetupidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_SetupextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SetupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SetupactionAction would contain either an operation or an assertion.TestReport_Action
TestReport_TeardownidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_TeardownextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TeardownmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TeardownactionThe teardown action will only contain an operation.TestReport_Action2
TestReport_TestidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestReport_TestextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TestnameThe name of this test used for tracking/logging purposes by test engines.string
TestReport_Test_nameExtensions for nameElement
TestReport_TestdescriptionA short description of the test used by test engines for tracking and reporting purposes.string
TestReport_Test_descriptionExtensions for descriptionElement
TestReport_TestactionAction would contain either an operation or an assertion.TestReport_Action1
TestScriptresourceTypeThis is a TestScript resourceTestScript
TestScriptidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
TestScriptmetaThe metadata about the resource. 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
TestScriptimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
TestScriptlanguageThe base language in which the resource is written.code
TestScript_languageExtensions for languageElement
TestScripttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
TestScriptcontainedThese 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
TestScriptextensionMay be 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
TestScriptmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
TestScripturlAn 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_urlExtensions for urlElement
TestScriptidentifierA 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
TestScriptversionThe 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_versionExtensions for versionElement
TestScriptnameA 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_nameExtensions for nameElement
TestScripttitleA short, descriptive, user-friendly title for the test script.string
TestScript_titleExtensions for titleElement
TestScriptstatusThe status of this test script. Enables tracking the life-cycle of the content.enum values:
draft
active
retired
unknown
TestScript_statusExtensions for statusElement
TestScriptexperimentalA 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_experimentalExtensions for experimentalElement
TestScriptdateThe 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_dateExtensions for dateElement
TestScriptpublisherThe name of the organization or individual that published the test script.string
TestScript_publisherExtensions for publisherElement
TestScriptcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
TestScriptdescriptionA free text natural language description of the test script from a consumer's perspective.markdown
TestScript_descriptionExtensions for descriptionElement
TestScriptuseContextThe 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
TestScriptjurisdictionA legal or geographic region in which the test script is intended to be used.CodeableConcept
TestScriptpurposeExplanation of why this test script is needed and why it has been designed as it has.markdown
TestScript_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
TestScriptoriginAn abstract server used in operations within this test script in the origin element.TestScript_Origin
TestScriptdestinationAn abstract server used in operations within this test script in the destination element.TestScript_Destination
TestScriptmetadataThe required capability must exist and are assumed to function correctly on the FHIR server being tested.TestScript_Metadata
TestScriptfixtureFixture in the test script - by reference (uri). All fixtures are required for the test script to execute.TestScript_Fixture
TestScriptprofileReference to the profile to be used for validation.Reference
TestScriptvariableVariable is set based either on element value in response body or on header field value in the response headers.TestScript_Variable
TestScriptsetupA series of required setup operations before tests are executed.TestScript_Setup
TestScripttestA test in this script.TestScript_Test
TestScriptteardownA series of operations required to clean up after all the tests are executed (successfully or otherwise).TestScript_Teardown
TestScript_ActionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_ActionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ActionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ActionoperationThe operation to perform.TestScript_Operation
TestScript_ActionassertEvaluates the results of previous operations to determine if the server under test behaves appropriately.TestScript_Assert
TestScript_Action1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_Action1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Action1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Action1operationAn operation would involve a REST request to a server.TestScript_Operation
TestScript_Action1assertEvaluates the results of previous operations to determine if the server under test behaves appropriately.TestScript_Assert
TestScript_Action2idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_Action2extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Action2modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Action2operationAn operation would involve a REST request to a server.TestScript_Operation
TestScript_AssertidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_AssertextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AssertmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AssertlabelThe label would be used for tracking/logging purposes by test engines.string
TestScript_Assert_labelExtensions for labelElement
TestScript_AssertdescriptionThe description would be used by test engines for tracking and reporting purposes.string
TestScript_Assert_descriptionExtensions for descriptionElement
TestScript_AssertdirectionThe direction to use for the assertion.enum values:
response
request
TestScript_Assert_directionExtensions for directionElement
TestScript_AssertcompareToSourceIdId of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.string
TestScript_Assert_compareToSourceIdExtensions for compareToSourceIdElement
TestScript_AssertcompareToSourceExpressionThe 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_compareToSourceExpressionExtensions for compareToSourceExpressionElement
TestScript_AssertcompareToSourcePathXPath 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_compareToSourcePathExtensions for compareToSourcePathElement
TestScript_AssertcontentTypeThe mime-type contents to compare against the request or response message 'Content-Type' header.code
TestScript_Assert_contentTypeExtensions for contentTypeElement
TestScript_AssertexpressionThe FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.string
TestScript_Assert_expressionExtensions for expressionElement
TestScript_AssertheaderFieldThe HTTP header field name e.g. 'Location'.string
TestScript_Assert_headerFieldExtensions for headerFieldElement
TestScript_AssertminimumIdThe ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.string
TestScript_Assert_minimumIdExtensions for minimumIdElement
navigationLinksWhether or not the test execution performs validation on the bundle navigation links.boolean
_navigationLinksExtensions for navigationLinksElement
TestScript_AssertoperatorThe 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_operatorExtensions for operatorElement
TestScript_AssertpathThe XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.string
TestScript_Assert_pathExtensions for pathElement
TestScript_AssertrequestMethodThe 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_requestMethodExtensions for requestMethodElement
TestScript_AssertrequestURLThe value to use in a comparison against the request URL path string.string
TestScript_Assert_requestURLExtensions for requestURLElement
TestScript_AssertresourceThe type of the resource. See http://build.fhir.org/resourcelist.html.code
TestScript_Assert_resourceExtensions for resourceElement
TestScript_Assertresponseokay | 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_responseExtensions for responseElement
TestScript_AssertresponseCodeThe value of the HTTP response code to be tested.string
TestScript_Assert_responseCodeExtensions for responseCodeElement
TestScript_AssertsourceIdFixture to evaluate the XPath/JSONPath expression or the headerField against.id
TestScript_Assert_sourceIdExtensions for sourceIdElement
TestScript_AssertvalidateProfileIdThe ID of the Profile to validate against.id
TestScript_Assert_validateProfileIdExtensions for validateProfileIdElement
TestScript_AssertvalueThe value to compare to.string
TestScript_Assert_valueExtensions for valueElement
TestScript_AssertwarningOnlyWhether or not the test execution will produce a warning only on error for this assert.boolean
TestScript_Assert_warningOnlyExtensions for warningOnlyElement
TestScript_CapabilityidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_CapabilityextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_CapabilitymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_CapabilityrequiredWhether or not the test execution will require the given capabilities of the server in order for this test script to execute.boolean
TestScript_Capability_requiredExtensions for requiredElement
TestScript_CapabilityvalidatedWhether or not the test execution will validate the given capabilities of the server in order for this test script to execute.boolean
TestScript_Capability_validatedExtensions for validatedElement
TestScript_CapabilitydescriptionDescription of the capabilities that this test script is requiring the server to support.string
TestScript_Capability_descriptionExtensions for descriptionElement
TestScript_CapabilityoriginWhich origin server these requirements apply to.integer
TestScript_Capability_originExtensions for originElement
TestScript_CapabilitydestinationWhich server these requirements apply to.integer
TestScript_Capability_destinationExtensions for destinationElement
linkLinks to the FHIR specification that describes this interaction and the resources involved in more detail.uri
_linkExtensions for linkElement
TestScript_CapabilitycapabilitiesMinimum 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_DestinationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_DestinationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DestinationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DestinationindexAbstract name given to a destination server in this test script. The name is provided as a number starting at 1.integer
TestScript_Destination_indexExtensions for indexElement
TestScript_DestinationprofileThe type of destination profile the test system supports.Coding
TestScript_FixtureidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_FixtureextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FixturemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FixtureautocreateWhether 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_autocreateExtensions for autocreateElement
TestScript_FixtureautodeleteWhether 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_autodeleteExtensions for autodeleteElement
TestScript_FixtureresourceReference to the resource (containing the contents of the resource needed for operations).Reference
idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
urlURL to a particular requirement or feature within the FHIR specification.uri
_urlExtensions for urlElement
descriptionShort description of the link.string
_descriptionExtensions for descriptionElement
TestScript_MetadataidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_MetadataextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_MetadatamodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
linkA link to the FHIR specification that this test is covering.TestScript_Link
TestScript_MetadatacapabilityCapabilities that must exist and are assumed to function correctly on the FHIR server being tested.TestScript_Capability
TestScript_OperationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_OperationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OperationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OperationtypeServer interaction or operation type.Coding
TestScript_OperationresourceThe type of the resource. See http://build.fhir.org/resourcelist.html.code
TestScript_Operation_resourceExtensions for resourceElement
TestScript_OperationlabelThe label would be used for tracking/logging purposes by test engines.string
TestScript_Operation_labelExtensions for labelElement
TestScript_OperationdescriptionThe description would be used by test engines for tracking and reporting purposes.string
TestScript_Operation_descriptionExtensions for descriptionElement
TestScript_OperationacceptThe mime-type to use for RESTful operation in the 'Accept' header.code
TestScript_Operation_acceptExtensions for acceptElement
TestScript_OperationcontentTypeThe mime-type to use for RESTful operation in the 'Content-Type' header.code
TestScript_Operation_contentTypeExtensions for contentTypeElement
TestScript_OperationdestinationThe server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.integer
TestScript_Operation_destinationExtensions for destinationElement
TestScript_OperationencodeRequestUrlWhether 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_encodeRequestUrlExtensions for encodeRequestUrlElement
TestScript_OperationmethodThe 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_methodExtensions for methodElement
TestScript_OperationoriginThe server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.integer
TestScript_Operation_originExtensions for originElement
TestScript_OperationparamsPath plus parameters after [type]. Used to set parts of the request URL explicitly.string
TestScript_Operation_paramsExtensions for paramsElement
TestScript_OperationrequestHeaderHeader elements would be used to set HTTP headers.TestScript_RequestHeader
TestScript_OperationrequestIdThe fixture id (maybe new) to map to the request.id
TestScript_Operation_requestIdExtensions for requestIdElement
TestScript_OperationresponseIdThe fixture id (maybe new) to map to the response.id
TestScript_Operation_responseIdExtensions for responseIdElement
TestScript_OperationsourceIdThe id of the fixture used as the body of a PUT or POST request.id
TestScript_Operation_sourceIdExtensions for sourceIdElement
TestScript_OperationtargetIdId of fixture used for extracting the [id], [type], and [vid] for GET requests.id
TestScript_Operation_targetIdExtensions for targetIdElement
TestScript_OperationurlComplete request URL.string
TestScript_Operation_urlExtensions for urlElement
TestScript_OriginidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_OriginextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_OriginmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_OriginindexAbstract name given to an origin server in this test script. The name is provided as a number starting at 1.integer
TestScript_Origin_indexExtensions for indexElement
TestScript_OriginprofileThe type of origin profile the test system supports.Coding
TestScript_RequestHeaderidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_RequestHeaderextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RequestHeadermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RequestHeaderfieldThe HTTP header field e.g. "Accept".string
TestScript_RequestHeader_fieldExtensions for fieldElement
TestScript_RequestHeadervalueThe value of the header e.g. "application/fhir+xml".string
TestScript_RequestHeader_valueExtensions for valueElement
TestScript_SetupidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_SetupextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_SetupmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_SetupactionAction would contain either an operation or an assertion.TestScript_Action
TestScript_TeardownidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_TeardownextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TeardownmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TeardownactionThe teardown action will only contain an operation.TestScript_Action2
TestScript_TestidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_TestextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_TestmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_TestnameThe name of this test used for tracking/logging purposes by test engines.string
TestScript_Test_nameExtensions for nameElement
TestScript_TestdescriptionA short description of the test used by test engines for tracking and reporting purposes.string
TestScript_Test_descriptionExtensions for descriptionElement
TestScript_TestactionAction would contain either an operation or an assertion.TestScript_Action1
TestScript_VariableidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TestScript_VariableextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_VariablemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_VariablenameDescriptive name for this variable.string
TestScript_Variable_nameExtensions for nameElement
TestScript_VariabledefaultValueA default, hard-coded, or user-defined value for this variable.string
TestScript_Variable_defaultValueExtensions for defaultValueElement
TestScript_VariabledescriptionA free text natural language description of the variable and its purpose.string
TestScript_Variable_descriptionExtensions for descriptionElement
TestScript_VariableexpressionThe 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_expressionExtensions for expressionElement
TestScript_VariableheaderFieldWill be used to grab the HTTP header field value from the headers that sourceId is pointing to.string
TestScript_Variable_headerFieldExtensions for headerFieldElement
TestScript_VariablehintDisplayable text string with hint help information to the user when entering a default value.string
TestScript_Variable_hintExtensions for hintElement
TestScript_VariablepathXPath 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_pathExtensions for pathElement
TestScript_VariablesourceIdFixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.id
TestScript_Variable_sourceIdExtensions for sourceIdElement
TimingidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TimingextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
TimingmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).Extension
TimingeventIdentifies specific times when the event occurs.dateTime
Timing_eventExtensions for eventElement
TimingrepeatA set of rules that describe when the event is scheduled.Timing_Repeat
TimingcodeA 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_RepeatidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
Timing_RepeatextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_RepeatmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_RepeatboundsDurationEither 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_RepeatboundsRangeEither 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_RepeatboundsPeriodEither 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_RepeatcountA 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_countExtensions for countElement
Timing_RepeatcountMaxIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.positiveInt
Timing_Repeat_countMaxExtensions for countMaxElement
Timing_RepeatdurationHow 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_durationExtensions for durationElement
Timing_RepeatdurationMaxIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.decimal
Timing_Repeat_durationMaxExtensions for durationMaxElement
Timing_RepeatdurationUnitThe units of time for the duration, in UCUM units.enum values:
s
min
h
d
wk
mo
a
Timing_Repeat_durationUnitExtensions for durationUnitElement
Timing_RepeatfrequencyThe 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_frequencyExtensions for frequencyElement
Timing_RepeatfrequencyMaxIf 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_frequencyMaxExtensions for frequencyMaxElement
Timing_RepeatperiodIndicates 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_periodExtensions for periodElement
Timing_RepeatperiodMaxIf 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_periodMaxExtensions for periodMaxElement
Timing_RepeatperiodUnitThe units of time for the period in UCUM units.enum values:
s
min
h
d
wk
mo
a
Timing_Repeat_periodUnitExtensions for periodUnitElement
Timing_RepeatdayOfWeekIf one or more days of week is provided, then the action happens only on the specified day(s).code
Timing_Repeat_dayOfWeekExtensions for dayOfWeekElement
Timing_RepeattimeOfDaySpecified time of day for action to take place.time
Timing_Repeat_timeOfDayExtensions for timeOfDayElement
Timing_RepeatwhenAn 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_whenExtensions for whenElement
Timing_RepeatoffsetThe 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_offsetExtensions for offsetElement
TriggerDefinitionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
TriggerDefinitionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
TriggerDefinitiontypeThe type of triggering event.enum values:
named-event
periodic
data-changed
data-added
data-modified
data-removed
data-accessed
data-access-ended
TriggerDefinition_typeExtensions for typeElement
TriggerDefinitionnameA 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_nameExtensions for nameElement
TriggerDefinitiontimingTimingThe timing of the event (if this is a periodic trigger).Timing
TriggerDefinitiontimingReferenceThe timing of the event (if this is a periodic trigger).Reference
TriggerDefinitiontimingDateThe timing of the event (if this is a periodic trigger).notDefined
TriggerDefinition_timingDateExtensions for timingDateElement
TriggerDefinitiontimingDateTimeThe timing of the event (if this is a periodic trigger).notDefined
TriggerDefinition_timingDateTimeExtensions for timingDateTimeElement
TriggerDefinitiondataThe 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
TriggerDefinitionconditionA 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
UsageContextidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
UsageContextextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Extension
UsageContextcodeA code that identifies the type of context being specified by this usage context.Coding
UsageContextvalueCodeableConceptA value that defines the context specified in this context of use. The interpretation of the value is defined by the code.CodeableConcept
UsageContextvalueQuantityA value that defines the context specified in this context of use. The interpretation of the value is defined by the code.Quantity
UsageContextvalueRangeA value that defines the context specified in this context of use. The interpretation of the value is defined by the code.Range
UsageContextvalueReferenceA value that defines the context specified in this context of use. The interpretation of the value is defined by the code.Reference
ValueSetresourceTypeThis is a ValueSet resourceValueSet
ValueSetidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
ValueSetmetaThe metadata about the resource. 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
ValueSetimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
ValueSetlanguageThe base language in which the resource is written.code
ValueSet_languageExtensions for languageElement
ValueSettextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
ValueSetcontainedThese 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
ValueSetextensionMay be 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
ValueSetmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
ValueSeturlAn 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_urlExtensions for urlElement
ValueSetidentifierA 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
ValueSetversionThe 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_versionExtensions for versionElement
ValueSetnameA 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_nameExtensions for nameElement
ValueSettitleA short, descriptive, user-friendly title for the value set.string
ValueSet_titleExtensions for titleElement
ValueSetstatusThe 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_statusExtensions for statusElement
ValueSetexperimentalA 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_experimentalExtensions for experimentalElement
ValueSetdateThe date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').dateTime
ValueSet_dateExtensions for dateElement
ValueSetpublisherThe name of the organization or individual that published the value set.string
ValueSet_publisherExtensions for publisherElement
ValueSetcontactContact details to assist a user in finding and communicating with the publisher.ContactDetail
ValueSetdescriptionA 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_descriptionExtensions for descriptionElement
ValueSetuseContextThe 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
ValueSetjurisdictionA legal or geographic region in which the value set is intended to be used.CodeableConcept
ValueSetpurposeExplanation of why this value set is needed and why it has been designed as it has.markdown
ValueSet_purposeExtensions for purposeElement
copyrightA 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
_copyrightExtensions for copyrightElement
ValueSetimmutableIf 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_immutableExtensions for immutableElement
ValueSetcomposeA 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
ValueSetexpansionA 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_ComposeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_ComposeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ComposemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ComposelockedDateThe 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_lockedDateExtensions for lockedDateElement
ValueSet_ComposeinactiveWhether 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_inactiveExtensions for inactiveElement
ValueSet_ComposeincludeInclude one or more codes from a code system or other value set(s).ValueSet_Include
ValueSet_ComposeexcludeExclude one or more codes from the value set based on code system filters and/or other value sets.ValueSet_Include
ValueSet_ComposepropertyA property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.string
ValueSet_Compose_propertyExtensions for propertyElement
ValueSet_ConceptidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_ConceptextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ConceptmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ConceptcodeSpecifies a code for the concept to be included or excluded.code
ValueSet_Concept_codeExtensions for codeElement
ValueSet_ConceptdisplayThe 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_displayExtensions for displayElement
ValueSet_ConceptdesignationAdditional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.ValueSet_Designation
ValueSet_ContainsidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_ContainsextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ContainsmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ContainssystemAn absolute URI which is the code system in which the code for this item in the expansion is defined.uri
ValueSet_Contains_systemExtensions for systemElement
ValueSet_ContainsabstractIf 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_abstractExtensions for abstractElement
ValueSet_ContainsinactiveIf 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_inactiveExtensions for inactiveElement
ValueSet_ContainsversionThe 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_versionExtensions for versionElement
ValueSet_ContainscodeThe 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_codeExtensions for codeElement
ValueSet_ContainsdisplayThe recommended display for this item in the expansion.string
ValueSet_Contains_displayExtensions for displayElement
ValueSet_ContainsdesignationAdditional 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_ContainspropertyA property value for this concept.ValueSet_Property1
ValueSet_ContainscontainsOther codes and entries contained under this entry in the hierarchy.ValueSet_Contains
ValueSet_DesignationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_DesignationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_DesignationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_DesignationlanguageThe language this designation is defined for.code
ValueSet_Designation_languageExtensions for languageElement
ValueSet_DesignationuseA code that represents types of uses of designations.Coding
ValueSet_DesignationvalueThe text value for this designation.string
ValueSet_Designation_valueExtensions for valueElement
ValueSet_ExpansionidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_ExpansionextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ExpansionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ExpansionidentifierAn 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_identifierExtensions for identifierElement
ValueSet_ExpansiontimestampThe time at which the expansion was produced by the expanding system.dateTime
ValueSet_Expansion_timestampExtensions for timestampElement
ValueSet_ExpansiontotalThe 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_totalExtensions for totalElement
ValueSet_ExpansionoffsetIf 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_offsetExtensions for offsetElement
ValueSet_ExpansionparameterA 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_ExpansionpropertyA property defines an additional slot through which additional information can be provided about a concept.ValueSet_Property
ValueSet_ExpansioncontainsThe codes that are contained in the value set expansion.ValueSet_Contains
ValueSet_FilteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_FilterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_FiltermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_FilterpropertyA code that identifies a property or a filter defined in the code system.code
ValueSet_Filter_propertyExtensions for propertyElement
ValueSet_FilteropThe 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_opExtensions for opElement
ValueSet_FiltervalueThe 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_valueExtensions for valueElement
ValueSet_IncludeidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_IncludeextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_IncludemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_IncludesystemAn absolute URI which is the code system from which the selected codes come from.uri
ValueSet_Include_systemExtensions for systemElement
ValueSet_IncludeversionThe version of the code system that the codes are selected from, or the special version '*' for all versions.string
ValueSet_Include_versionExtensions for versionElement
ValueSet_IncludeconceptSpecifies a concept to be included or excluded.ValueSet_Concept
ValueSet_IncludefilterSelect 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_IncludevalueSetSelects 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_ParameteridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_ParameterextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ParametermodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ParameternameName 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_nameExtensions for nameElement
ValueSet_ParametervalueStringThe value of the parameter.notDefined
ValueSet_Parameter_valueStringExtensions for valueStringElement
ValueSet_ParametervalueBooleanThe value of the parameter.notDefined
ValueSet_Parameter_valueBooleanExtensions for valueBooleanElement
ValueSet_ParametervalueIntegerThe value of the parameter.notDefined
ValueSet_Parameter_valueIntegerExtensions for valueIntegerElement
ValueSet_ParametervalueDecimalThe value of the parameter.notDefined
ValueSet_Parameter_valueDecimalExtensions for valueDecimalElement
ValueSet_ParametervalueUriThe value of the parameter.notDefined
ValueSet_Parameter_valueUriExtensions for valueUriElement
ValueSet_ParametervalueCodeThe value of the parameter.notDefined
ValueSet_Parameter_valueCodeExtensions for valueCodeElement
ValueSet_ParametervalueDateTimeThe value of the parameter.notDefined
ValueSet_Parameter_valueDateTimeExtensions for valueDateTimeElement
ValueSet_PropertyidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_PropertyextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PropertymodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PropertycodeA code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.code
ValueSet_Property_codeExtensions for codeElement
ValueSet_PropertyuriReference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.uri
ValueSet_Property_uriExtensions for uriElement
ValueSet_Property1idUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
ValueSet_Property1extensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_Property1modifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_Property1codeA code that is a reference to ValueSet.expansion.property.code.code
ValueSet_Property1_codeExtensions for codeElement
ValueSet_Property1valueCodeThe value of this property.notDefined
ValueSet_Property1_valueCodeExtensions for valueCodeElement
ValueSet_Property1valueCodingThe value of this property.Coding
ValueSet_Property1valueStringThe value of this property.notDefined
ValueSet_Property1_valueStringExtensions for valueStringElement
ValueSet_Property1valueIntegerThe value of this property.notDefined
ValueSet_Property1_valueIntegerExtensions for valueIntegerElement
ValueSet_Property1valueBooleanThe value of this property.notDefined
ValueSet_Property1_valueBooleanExtensions for valueBooleanElement
ValueSet_Property1valueDateTimeThe value of this property.notDefined
ValueSet_Property1_valueDateTimeExtensions for valueDateTimeElement
ValueSet_Property1valueDecimalThe value of this property.notDefined
ValueSet_Property1_valueDecimalExtensions for valueDecimalElement
VerificationResultresourceTypeThis is a VerificationResult resourceVerificationResult
VerificationResultidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
VerificationResultmetaThe metadata about the resource. 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
VerificationResultimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
VerificationResultlanguageThe base language in which the resource is written.code
VerificationResult_languageExtensions for languageElement
VerificationResulttextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
VerificationResultcontainedThese 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
VerificationResultextensionMay be 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
VerificationResultmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
VerificationResulttargetA resource that was validated.Reference
VerificationResulttargetLocationThe fhirpath location(s) within the resource that was validated.string
VerificationResult_targetLocationExtensions for targetLocationElement
VerificationResultneedThe frequency with which the target must be validated (none; initial; periodic).CodeableConcept
VerificationResultstatusThe validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).code
VerificationResult_statusExtensions for statusElement
VerificationResultstatusDateWhen the validation status was updated.dateTime
VerificationResult_statusDateExtensions for statusDateElement
VerificationResultvalidationTypeWhat the target is validated against (nothing; primary source; multiple sources).CodeableConcept
VerificationResultvalidationProcessThe primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).CodeableConcept
VerificationResultfrequencyFrequency of revalidation.Timing
VerificationResultlastPerformedThe date/time validation was last completed (including failed validations).dateTime
VerificationResult_lastPerformedExtensions for lastPerformedElement
VerificationResultnextScheduledThe date when target is next validated, if appropriate.date
VerificationResult_nextScheduledExtensions for nextScheduledElement
VerificationResultfailureActionThe result if validation fails (fatal; warning; record only; none).CodeableConcept
VerificationResultprimarySourceInformation about the primary source(s) involved in validation.VerificationResult_PrimarySource
VerificationResultattestationInformation about the entity attesting to information.VerificationResult_Attestation
VerificationResultvalidatorInformation about the entity validating information.VerificationResult_Validator
VerificationResult_AttestationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
VerificationResult_AttestationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_AttestationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_AttestationwhoThe individual or organization attesting to information.Reference
VerificationResult_AttestationonBehalfOfWhen the who is asserting on behalf of another (organization or individual).Reference
VerificationResult_AttestationcommunicationMethodThe method by which attested information was submitted/retrieved (manual; API; Push).CodeableConcept
VerificationResult_AttestationdateThe date the information was attested to.date
VerificationResult_Attestation_dateExtensions for dateElement
VerificationResult_AttestationsourceIdentityCertificateA digital identity certificate associated with the attestation source.string
VerificationResult_Attestation_sourceIdentityCertificateExtensions for sourceIdentityCertificateElement
VerificationResult_AttestationproxyIdentityCertificateA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.string
VerificationResult_Attestation_proxyIdentityCertificateExtensions for proxyIdentityCertificateElement
VerificationResult_AttestationproxySignatureSigned assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.Signature
VerificationResult_AttestationsourceSignatureSigned assertion by the attestation source that they have attested to the information.Signature
VerificationResult_PrimarySourceidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
VerificationResult_PrimarySourceextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PrimarySourcemodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PrimarySourcewhoReference to the primary source.Reference
VerificationResult_PrimarySourcetypeType of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).CodeableConcept
VerificationResult_PrimarySourcecommunicationMethodMethod for communicating with the primary source (manual; API; Push).CodeableConcept
VerificationResult_PrimarySourcevalidationStatusStatus of the validation of the target against the primary source (successful; failed; unknown).CodeableConcept
VerificationResult_PrimarySourcevalidationDateWhen the target was validated against the primary source.dateTime
VerificationResult_PrimarySource_validationDateExtensions for validationDateElement
VerificationResult_PrimarySourcecanPushUpdatesAbility of the primary source to push updates/alerts (yes; no; undetermined).CodeableConcept
VerificationResult_PrimarySourcepushTypeAvailableType of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).CodeableConcept
VerificationResult_ValidatoridUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
VerificationResult_ValidatorextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_ValidatormodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_ValidatororganizationReference to the organization validating information.Reference
VerificationResult_ValidatoridentityCertificateA digital identity certificate associated with the validator.string
VerificationResult_Validator_identityCertificateExtensions for identityCertificateElement
VerificationResult_ValidatorattestationSignatureSigned assertion by the validator that they have validated the information.Signature
VisionPrescriptionresourceTypeThis is a VisionPrescription resourceVisionPrescription
VisionPrescriptionidThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.id
VisionPrescriptionmetaThe metadata about the resource. 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
VisionPrescriptionimplicitRulesA reference to a set of rules that were followed when the resource was constructed, and which must be 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_implicitRulesExtensions for implicitRulesElement
VisionPrescriptionlanguageThe base language in which the resource is written.code
VisionPrescription_languageExtensions for languageElement
VisionPrescriptiontextA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" 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
VisionPrescriptioncontainedThese 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
VisionPrescriptionextensionMay be 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
VisionPrescriptionmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the 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
VisionPrescriptionidentifierA unique identifier assigned to this vision prescription.Identifier
VisionPrescriptionstatusThe status of the resource instance.code
VisionPrescription_statusExtensions for statusElement
VisionPrescriptioncreatedThe date this resource was created.dateTime
VisionPrescription_createdExtensions for createdElement
VisionPrescriptionpatientA resource reference to the person to whom the vision prescription applies.Reference
VisionPrescriptionencounterA reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.Reference
VisionPrescriptiondateWrittenThe date (and perhaps time) when the prescription was written.dateTime
VisionPrescription_dateWrittenExtensions for dateWrittenElement
VisionPrescriptionprescriberThe healthcare professional responsible for authorizing the prescription.Reference
VisionPrescriptionlensSpecificationContain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.VisionPrescription_LensSpecification
VisionPrescription_LensSpecificationidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
VisionPrescription_LensSpecificationextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_LensSpecificationmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_LensSpecificationproductIdentifies the type of vision correction product which is required for the patient.CodeableConcept
VisionPrescription_LensSpecificationeyeThe eye for which the lens specification applies.enum values:
right
left
VisionPrescription_LensSpecification_eyeExtensions for eyeElement
VisionPrescription_LensSpecificationsphereLens power measured in dioptres (0.25 units).decimal
VisionPrescription_LensSpecification_sphereExtensions for sphereElement
VisionPrescription_LensSpecificationcylinderPower adjustment for astigmatism measured in dioptres (0.25 units).decimal
VisionPrescription_LensSpecification_cylinderExtensions for cylinderElement
VisionPrescription_LensSpecificationaxisAdjustment for astigmatism measured in integer degrees.integer
VisionPrescription_LensSpecification_axisExtensions for axisElement
VisionPrescription_LensSpecificationprismAllows for adjustment on two axis.VisionPrescription_Prism
VisionPrescription_LensSpecificationaddPower adjustment for multifocal lenses measured in dioptres (0.25 units).decimal
VisionPrescription_LensSpecification_addExtensions for addElement
VisionPrescription_LensSpecificationpowerContact lens power measured in dioptres (0.25 units).decimal
VisionPrescription_LensSpecification_powerExtensions for powerElement
VisionPrescription_LensSpecificationbackCurveBack curvature measured in millimetres.decimal
VisionPrescription_LensSpecification_backCurveExtensions for backCurveElement
VisionPrescription_LensSpecificationdiameterContact lens diameter measured in millimetres.decimal
VisionPrescription_LensSpecification_diameterExtensions for diameterElement
VisionPrescription_LensSpecificationdurationThe recommended maximum wear period for the lens.Quantity
VisionPrescription_LensSpecificationcolorSpecial color or pattern.string
VisionPrescription_LensSpecification_colorExtensions for colorElement
VisionPrescription_LensSpecificationbrandBrand recommendations or restrictions.string
VisionPrescription_LensSpecification_brandExtensions for brandElement
VisionPrescription_LensSpecificationnoteNotes for special requirements such as coatings and lens materials.Annotation
VisionPrescription_PrismidUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.string
VisionPrescription_PrismextensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any 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_PrismmodifierExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier 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_PrismamountAmount of prism to compensate for eye alignment in fractional units.decimal
VisionPrescription_Prism_amountExtensions for amountElement
VisionPrescription_PrismbaseThe relative base, or reference lens edge, for the prism.enum values:
up
down
in
out
VisionPrescription_Prism_baseExtensions for baseElement