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_