This is the base Capability Statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from
\n| Mode | SERVER |
| Description | All the functionality defined in FHIR \n |
| Transaction | y |
| System History | y |
| System Search | y |
This is the base Capability Statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from. A capability statement has to contain something, so this contains a read of a Capability Statement
\n| Mode | SERVER |
| Description | An empty Capability Statement \n |
| Transaction | |
| System History | |
| System Search |
| Resource Type | Profile | Read | Search | Update | Create |
|---|
\r\nThe following resources may be in this compartment:\r\n
\r\n| Resource | Inclusion Criteria |
| Account | subject |
| Appointment | actor |
| AppointmentResponse | actor |
| AuditEvent | agent |
| ChargeItem | enterer, performer-actor |
| Claim | procedure-udi, item-udi, detail-udi, subdetail-udi |
| Communication | sender, recipient |
| CommunicationRequest | information-provider, recipient |
| Composition | author |
| DetectedIssue | author |
| DeviceAssociation | device |
| DeviceRequest | subject, requester, performer |
| DiagnosticReport | subject |
| DocumentReference | subject, author |
| ExplanationOfBenefit | procedure-udi, item-udi, detail-udi, subdetail-udi |
| Flag | author |
| Group | member |
| Invoice | participant |
| List | subject, source |
| MessageHeader | target |
| Observation | subject, device |
| Provenance | agent |
| QuestionnaireResponse | author |
| RequestOrchestration | author |
| ResearchSubject | subject |
| RiskAssessment | performer |
| Schedule | actor |
| ServiceRequest | performer, requester |
| Specimen | subject |
| SupplyRequest | requester |
\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\nThe following resources may be in this compartment:\r\n
\r\n| Resource | Inclusion Criteria |
| CarePlan | encounter |
| ChargeItem | encounter |
| Claim | encounter |
| ClinicalImpression | encounter |
| Communication | encounter |
| CommunicationRequest | encounter |
| Composition | encounter |
| Condition | encounter |
| DeviceRequest | encounter |
| DiagnosticReport | encounter |
| DocumentReference | context |
| Encounter | {def} |
| EncounterHistory | encounter |
| ExplanationOfBenefit | encounter |
| MedicationAdministration | encounter |
| MedicationDispense | encounter |
| MedicationRequest | encounter |
| MedicationStatement | encounter |
| NutritionIntake | encounter |
| NutritionOrder | encounter |
| Observation | encounter |
| Procedure | encounter |
| QuestionnaireResponse | encounter |
| RequestOrchestration | encounter |
| ServiceRequest | encounter |
| VisionPrescription | encounter |
\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\nThe following resources may be in this compartment:\r\n
\r\n| Resource | Inclusion Criteria |
| Account | subject |
| AdverseEvent | subject |
| AllergyIntolerance | patient, participant |
| Appointment | actor |
| AppointmentResponse | actor |
| AuditEvent | patient |
| Basic | patient, author |
| BiologicallyDerivedProductDispense | patient |
| BodyStructure | patient |
| CarePlan | patient |
| CareTeam | patient, participant |
| ChargeItem | subject |
| Claim | patient, payee |
| ClaimResponse | patient |
| ClinicalImpression | subject |
| Communication | subject, sender, recipient |
| CommunicationRequest | subject, information-provider, recipient, requester |
| Composition | subject, author, attester |
| Condition | patient, participant-actor |
| Consent | subject |
| Contract | patient |
| Coverage | policy-holder, subscriber, beneficiary, paymentby-party |
| CoverageEligibilityRequest | patient |
| CoverageEligibilityResponse | patient |
| DetectedIssue | patient |
| DeviceAssociation | subject, operator |
| DeviceRequest | subject, performer |
| DeviceUsage | patient |
| DiagnosticReport | subject |
| DocumentReference | subject, author |
| Encounter | patient |
| EncounterHistory | patient |
| EnrollmentRequest | subject |
| EpisodeOfCare | patient |
| ExplanationOfBenefit | patient, payee |
| FamilyMemberHistory | patient |
| Flag | patient |
| GenomicStudy | patient |
| Goal | patient |
| Group | member |
| GuidanceResponse | patient |
| ImagingSelection | patient |
| ImagingStudy | patient |
| Immunization | patient |
| ImmunizationEvaluation | patient |
| ImmunizationRecommendation | patient |
| Invoice | subject, patient, recipient |
| List | subject, source |
| MeasureReport | patient |
| MedicationAdministration | patient, subject |
| MedicationDispense | subject, patient, receiver |
| MedicationRequest | subject |
| MedicationStatement | subject |
| MolecularSequence | subject |
| NutritionIntake | subject, source |
| NutritionOrder | patient |
| Observation | subject, performer |
| Patient | {def}, link |
| Person | patient |
| Procedure | patient, performer |
| Provenance | patient |
| QuestionnaireResponse | subject, author |
| RelatedPerson | patient |
| RequestOrchestration | subject, participant |
| ResearchSubject | subject |
| RiskAssessment | subject |
| Schedule | actor |
| ServiceRequest | subject, performer |
| Specimen | subject |
| SupplyDelivery | patient |
| SupplyRequest | subject |
| Task | patient, focus |
| VisionPrescription | patient |
\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\nThe following resources may be in this compartment:\r\n
\r\n| Resource | Inclusion Criteria |
| Account | subject |
| AdverseEvent | recorder |
| AllergyIntolerance | participant |
| Appointment | actor |
| AppointmentResponse | actor |
| AuditEvent | agent |
| Basic | author |
| BiologicallyDerivedProductDispense | performer |
| CareTeam | participant |
| ChargeItem | enterer, performer-actor |
| Claim | enterer, provider, payee, care-team |
| ClaimResponse | requestor |
| ClinicalImpression | performer |
| Communication | sender, recipient |
| CommunicationRequest | information-provider, recipient, requester |
| Composition | subject, author, attester |
| Condition | participant-actor |
| CoverageEligibilityRequest | enterer, provider |
| CoverageEligibilityResponse | requestor |
| DetectedIssue | author |
| DeviceAssociation | operator |
| DeviceRequest | requester, performer |
| DiagnosticReport | performer |
| DocumentReference | subject, author, attester |
| Encounter | practitioner, participant |
| EpisodeOfCare | care-manager |
| ExplanationOfBenefit | enterer, provider, payee, care-team |
| Flag | author |
| Group | member |
| Immunization | performer |
| Invoice | participant |
| Linkage | author |
| List | source |
| MedicationDispense | performer, receiver |
| MedicationRequest | requester |
| MedicationStatement | source |
| MessageHeader | receiver, author, responsible |
| NutritionIntake | source |
| NutritionOrder | provider |
| Observation | performer |
| Patient | general-practitioner |
| PaymentNotice | reporter |
| PaymentReconciliation | requestor |
| Person | practitioner |
| Practitioner | {def} |
| PractitionerRole | practitioner |
| Procedure | performer |
| Provenance | agent |
| QuestionnaireResponse | author, source |
| RequestOrchestration | participant, author |
| RiskAssessment | performer |
| Schedule | actor |
| ServiceRequest | performer, requester |
| Specimen | collector |
| SupplyDelivery | supplier, receiver |
| SupplyRequest | requester |
| VisionPrescription | prescriber |
\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\n\r\nThe following resources may be in this compartment:\r\n
\r\n| Resource | Inclusion Criteria |
| AdverseEvent | recorder |
| AllergyIntolerance | participant |
| Appointment | actor |
| AppointmentResponse | actor |
| Basic | author |
| CareTeam | participant |
| ChargeItem | enterer, performer-actor |
| Claim | payee |
| Communication | sender, recipient |
| CommunicationRequest | information-provider, recipient, requester |
| Composition | author |
| Condition | participant-actor |
| Coverage | policy-holder, subscriber, paymentby-party |
| DocumentReference | author |
| Encounter | participant |
| ExplanationOfBenefit | payee |
| Invoice | recipient |
| MedicationStatement | source |
| NutritionIntake | source |
| Observation | performer |
| Patient | link |
| Person | link |
| Procedure | performer |
| Provenance | agent |
| QuestionnaireResponse | author, source |
| RelatedPerson | {def} |
| RequestOrchestration | participant |
| Schedule | actor |
| ServiceRequest | performer |
| SupplyRequest | requester |
\r\nA resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.\r\n
\r\n\r\n\r\n
\r\n\r\nThe following resources are never in this compartment:\r\n
\r\nURL: [base]/ActivityDefinition/$apply
URL: [base]/ActivityDefinition/[id]/$apply
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | activityDefinition | type | 0..1 | ActivityDefinition | The activity definition to apply. If the operation is invoked on an instance, this parameter is not allowed. If the operation is invoked at the type level, this parameter is required \n | |
| IN | subject | 1..* | string (reference) | The subject(s) that is/are the target of the activity definition to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined \n | ||
| IN | encounter | 0..1 | string (reference) | The encounter in context, if any \n | ||
| IN | practitioner | 0..1 | string (reference) | The practitioner in context \n | ||
| IN | organization | 0..1 | string (reference) | The organization in context \n | ||
| IN | userType | 0..1 | CodeableConcept | The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.) \n | ||
| IN | userLanguage | 0..1 | CodeableConcept | Preferred language of the person using the system \n | ||
| IN | userTaskContext | 0..1 | CodeableConcept | The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources \n | ||
| IN | setting | 0..1 | CodeableConcept | The current setting of the request (inpatient, outpatient, etc.) \n | ||
| IN | settingContext | 0..1 | CodeableConcept | Additional detail about the setting of the request, if any \n | ||
| OUT | return | 1..1 | Resource | The resource that is the result of applying the definition \n |
The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the ActivityDefinition resource. Note that result of this operation is transient (i.e. none of the resources created by the operation are persisted in the server, they are all returned as contained resources in the result). The result effectively represents a proposed set of activities, and it is up to the caller to determine whether and how those activities are actually carried out.
\nURL: [base]/ActivityDefinition/[id]/$data-requirements
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| OUT | return | 1..1 | Library | The result of the requirements gathering represented as a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the activity definition \n |
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the activity definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the activity definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)
\nURL: [base]/$current-canonical
URL: [base]/CanonicalResource/$current-canonical
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | 1..1 | uri | This is the canonical URL (with no version declared) \n | ||
| IN | status | 0..* | code | The statuses to allow to be returned. If no status codes are provided, then any status is ok \n | ||
| OUT | result | 0..1 | CanonicalResource | If no resources can be found, will return nothing. If multiple resources are found for the specified statuses and 'most current' can't be determined by comparing the versions, the operation will fail with an operation outcome. \n |
If none of the instances define the versionAlgorithm to use, a server may dynamically attempt to determine which versioning system is implied by the data.
\nIf the instances found with the provided canonical URL define different versionAlgorithm values the server may return an error.
\nNote that the CanonicalResource is an interface and not an actual resource type, as such the operation is actually called on the canonical resource types such as CodeSystem, Questionnaire etc.
\nURL: [base]/CapabilityStatement/$conforms
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | left | 0..1 | canonical | A canonical reference to the left-hand system's capability statement \n | ||
| IN | right | 0..1 | canonical | A canonical reference to the right-hand system's capability statement \n | ||
| IN | mode | 0..1 | code | What kind of comparison to perform - server to server, or client to server (use the codes 'server/server' or 'client/server') \n | ||
| OUT | issues | 1..1 | OperationOutcome | Outcome of the CapabilityStatement test \n | ||
| OUT | union | 0..1 | CapabilityStatement | The intersection of the functionality described by the CapabilityStatement resources \n | ||
| OUT | intersection | 0..1 | CapabilityStatement | The union of the functionality described by the CapabilityStatement resources \n |
The operation performs a full comparison of the functionality described by the two capability statements, including the profiles and value sets they reference, and also including concept maps and structure maps.
\nThe full execution of this operation is still a matter of research, but it is intended to support comparison of systems to see if they will interoperate
\nIf the capability statements can be successfully compared, then the return value is a 200 OK with an OperationOutcome along with intersection and union capability statements. The operation outcome can contain errors relating to differences between the capability statements. If the capability statements cannot be compared, because dependencies cannot be located, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error
\nURL: [base]/CapabilityStatement/$implements
URL: [base]/CapabilityStatement/[id]/$implements
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | server | 0..1 | canonical | A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point) \n | ||
| IN | client | 0..1 | canonical | A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point) \n | ||
| IN | resource | 0..1 | CapabilityStatement | The client capability statement, provided inline \n | ||
| OUT | return | 1..1 | OperationOutcome | Outcome of the CapabilityStatement test \n |
The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided Technically, this operation is implemented as follows:
\nIf the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error
\nURL: [base]/CapabilityStatement/$subset
URL: [base]/CapabilityStatement/[id]/$subset
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | server | type, system | 0..1 | uri | The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point) \n | |
| IN | resource | 1..* | code | A resource that the client would like to include in the return \n | ||
| OUT | return | 1..1 | CapabilityStatement | The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code \n |
URL: [base]/$versions
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| OUT | version | 1..* | code | A version supported by the server. Use the major.minor version like 3.0 \n | ||
| OUT | default | 1..1 | code | FHIRVersion (Required) | The default version for the server. Use the major.minor version like 3.0 \n |
URL: [base]/ChargeItemDefinition/[id]/$apply
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | chargeItem | 1..1 | Reference | The ChargeItem on which the definition is to ba applies \n | ||
| IN | account | 0..1 | Reference | The account in context, if any \n | ||
| OUT | return | 1..1 | Resource | The resource that is the result of applying the definition \n |
The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated (in the order in which they appear in the resource) and the results applied to the returned resource. If the ChargetItemDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. For a more detailed description, refer to the ChargetItemDefinition resource
\nURL: [base]/Claim/$submit
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | resource | 1..1 | Resource | A Claim resource or Bundle of claims, either as individual Claim resources or as Bundles each containing a single Claim plus referenced resources. \n | ||
| OUT | return | 1..1 | Resource | A ClaimResponse resource or Bundle of claim responses, either as individual ClaimResponse resources or as Bundles each containing a single ClaimResponse plus referenced resources. \n |
URL: [base]/CodeSystem/$find-matches
URL: [base]/CodeSystem/[id]/$find-matches
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | system | type | 0..1 | uri | The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance \n | |
| IN | version | type | 0..1 | string | The version of the system for the inferencing to be performed \n | |
| IN | property | 0..* | One or more properties that contain information to be composed into the code \n | |||
| IN | property.code | 1..1 | code | Identifies the property provided \n | ||
| IN | property.value | 0..1 | Coding | boolean | code | dateTime | integer | string | The value of the property provided \n | ||
| IN | property.subproperty | 0..* | Nested Properties (mainly used for SNOMED CT composition, for relationship Groups) \n | |||
| IN | property.subproperty.code | 1..1 | code | Identifies the sub-property provided \n | ||
| IN | property.subproperty.value | 1..1 | Coding | boolean | code | dateTime | integer | string | The value of the sub-property provided \n | ||
| IN | exact | 1..1 | boolean | Whether the operation is being used by a human ('false'), or a machine ('true'). If the operation is being used by a human, the terminology server can return a list of possible matches, with commentary. For a machine, the server returns complete or partial matches, not possible matches. The default value is 'false' \n | ||
| IN | compositional | 0..1 | boolean | Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false \n | ||
| OUT | match | 0..* | Concepts returned by the server as a result of the inferencing operation \n | |||
| OUT | match.code | 1..1 | Coding | A code that matches the properties provided \n | ||
| OUT | match.unmatched | 0..* | One or more properties that contain properties that could not be matched into the code \n | |||
| OUT | match.unmatched.code | 1..1 | code | Identifies the property provided \n | ||
| OUT | match.unmatched.value | 1..1 | Coding | boolean | code | dateTime | integer | string | The value of the property provided \n | ||
| OUT | match.unmatched.property | 0..* | Nested Properties (mainly used for SNOMED CT composition, for relationship Groups) \n | |||
| OUT | match.unmatched.property.code | 1..1 | code | Identifies the sub-property provided \n | ||
| OUT | match.unmatched.property.value | 1..1 | Coding | boolean | code | dateTime | integer | string | The value of the sub-property provided \n | ||
| OUT | match.comment | 0..1 | string | Information about the quality of the match, if operation is for a human \n |
URL: [base]/CodeSystem/$lookup
URL: [base]/CodeSystem/[id]/$lookup
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | code | 0..1 | code | The code that is to be located. If a code is provided, a system must be provided \n | ||
| IN | system | type | 0..1 | uri | The system for the code that is to be located \n | |
| IN | version | type | 0..1 | string | The version of the system, if one was provided in the source data \n | |
| IN | coding | 0..1 | Coding | A coding to look up \n | ||
| IN | date | 0..1 | dateTime | The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy. \n | ||
| IN | displayLanguage | 0..1 | code | The requested language for display (see CodeSystem.concept.designation.language) \n | ||
| IN | property | 0..* | code | A property that the client wishes to be returned in the output. If no properties are specified, the server chooses what to return. The following properties are defined for all code systems: name, version (code system info) and code information: display, designation, and lang.X where X is a designation language code. These properties are returned explicitly in named out parameters with matching names, or in designations. In addition, any property codes defined by this specification or by the CodeSystem (CodeSystem.property.code) are allowed, and these are returned in the out parameter | ||
| IN | useSupplement | 0..* | canonical | Supplements to take into account when performing the $lookup operation. The supplements must be for the same CodeSystem. By default, supplements for the code system are not automatically included except where they provide additional designations that may be indicated by, for example, the displayLanguage parameter \n | ||
| OUT | name | 1..1 | string | A display name for the code system \n | ||
| OUT | version | 0..1 | string | The version that these details are based on \n | ||
| OUT | display | 1..1 | string | The preferred display for this concept \n | ||
| OUT | definition | 0..1 | string | A statement of the meaning of the concept from the code system \n | ||
| OUT | designation | 0..* | Additional representations for this concept \n | |||
| OUT | designation.language | 0..1 | code | The language this designation is defined for \n | ||
| OUT | designation.use | 0..1 | Coding | A code that details how this designation would be used \n | ||
| OUT | designation.additionalUse | 0..* | Coding | Additional codes that detail how this designation would be used (if there is more than one) \n | ||
| OUT | designation.value | 1..1 | string | The text value for this designation \n | ||
| OUT | property | 0..* | One or more properties that contain additional information about the code, including status. For complex terminologies (e.g. SNOMED CT, LOINC, medications), these properties serve to decompose the code \n | |||
| OUT | property.code | 1..1 | code | Identifies the property returned \n | ||
| OUT | property.value | 0..1 | Coding | boolean | code | dateTime | decimal | integer | string | The value of the property returned \n | ||
| OUT | property.description | 0..1 | string | Human Readable representation of the property value (e.g. display for a code) \n | ||
| OUT | property.source | 0..1 | canonical | If information from a supplement is included as a property (e.g. any additional property or property value), then this parameter must assert the url of the supplement. \n | ||
| OUT | property.subproperty | 0..* | Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups) \n | |||
| OUT | property.subproperty.code | 1..1 | code | Identifies the sub-property returned \n | ||
| OUT | property.subproperty.value | 1..1 | Coding | boolean | code | dateTime | decimal | integer | string | The value of the sub-property returned \n | ||
| OUT | property.subproperty.description | 0..1 | string | Human Readable representation of the sub-property value (e.g. display for a code) \n | ||
| OUT | property.subproperty.source | 0..1 | canonical | If information from a supplement is included as a subproperty (e.g. any additional subproperty or subproperty value), then this parameter must assert the url of the supplement. \n |
Note that the $lookup operation is more than just a code system search - the server finds the concept, and gathers the return information from the underlying code system definitions.
\nURL: [base]/CodeSystem/$subsumes
URL: [base]/CodeSystem/[id]/$subsumes
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | codeA | 0..1 | code | The "A" code that is to be tested. If a code is provided, a system must be provided \n | ||
| IN | codeB | 0..1 | code | The "B" code that is to be tested. If a code is provided, a system must be provided \n | ||
| IN | system | type | 0..1 | uri | The code system in which subsumption testing is to be performed. This must be provided unless the operation is invoked on a code system instance \n | |
| IN | version | type | 0..1 | string | The version of the code system, if one was provided in the source data \n | |
| IN | codingA | 0..1 | Coding | The "A" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established \n | ||
| IN | codingB | 0..1 | Coding | The "B" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established \n | ||
| OUT | outcome | 1..1 | code | Concept Subsumption Outcome (Required) | The subsumption relationship between code/Coding "A" and code/Coding "B". There are 4 possible codes to be returned (equivalent, subsumes, subsumed-by, and not-subsumed) as defined in the concept-subsumption-outcome value set. If the server is unable to determine the relationship between the codes/Codings, then it returns an error response with an OperationOutcome. \n |
URL: [base]/CodeSystem/$validate-code
URL: [base]/CodeSystem/[id]/$validate-code
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | type | 0..1 | uri | CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server'scode systems, or it is known implicitly by the server \n | |
| IN | codeSystem | type | 0..1 | CodeSystem | The codeSystem is provided directly as part of the request. Servers may choose not to accept code systems in this fashion. This parameter is used when the client wants the server to check against a code system that is not stored on the server \n | |
| IN | code | 0..1 | code | The code that is to be validated \n | ||
| IN | version | type | 0..1 | string | The version of the code system, if one was provided in the source data \n | |
| IN | display | 0..1 | string | The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent \n | ||
| IN | coding | 0..1 | Coding | A coding to validate. The system must match the specified code system \n | ||
| IN | codeableConcept | 0..1 | CodeableConcept | A full codeableConcept to validate. The server returns true if one of the coding values is in the code system, and may also validate that the codings are not in conflict with each other if more than one is present \n | ||
| IN | date | 0..1 | dateTime | The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy. \n | ||
| IN | abstract | 0..1 | boolean | If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid. \nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context. \n | ||
| IN | displayLanguage | 0..1 | code | Specifies the language to be used for description when validating the display property \n | ||
| OUT | result | 1..1 | boolean | True if the concept details supplied are valid \n | ||
| OUT | message | 0..1 | string | Error details, if result = false. If this is provided when result = true, the message carries hints and warnings \n | ||
| OUT | display | 0..1 | string | A valid display for the concept if the system wishes to display this to a user \n | ||
| OUT | code | 0..1 | code | The code that was validated \n | ||
| OUT | system | 0..1 | uri | The system for the code that was validated \n | ||
| OUT | version | 0..1 | string | The version of the system of the code that was validated \n | ||
| OUT | codeableConcept | 0..1 | CodeableConcept | A codeableConcept containing codings for all the validated codes \n | ||
| OUT | issues | 0..1 | OperationOutcome | List of itemised issues with paths constrained to simple FHIRPath. Examples are CodeableConcept, CodeableConcept.coding[0], CodeableConcept.coding[1].display, or Coding.display \n |
URL: [base]/Composition/[id]/$document
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | persist | 0..1 | boolean | Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, its location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response \n | ||
| IN | graph | 0..1 | uri | Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources \n | ||
| OUT | return | 1..1 | Bundle | The bundle containing the composition and resources associated with it. See FHIR Documents for information on resources that may be included in the bundle. \n |
Notes:
\nURL: [base]/$closure
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | name | 1..1 | string | The name that defines the particular context for the subsumption based closure table \n | ||
| IN | concept | 0..* | Coding | Concepts to add to the closure table \n | ||
| IN | version | 0..1 | string | A request to resynchronise - request to send all new entries since the nominated version was sent by the server \n | ||
| OUT | return | 1..1 | ConceptMap | A list of new entries (code / system --> code/system) that the client should add to its closure table. The only kind of entry mapping relationships that can be returned are equivalent, source-is-broader-than-target and source-is-narrower-than-target. \n |
URL: [base]/ConceptMap/$translate
URL: [base]/ConceptMap/[id]/$translate
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | type | 0..1 | uri | A canonical URL for a concept map. The server must know the concept map (e.g. it is defined explicitly in the server's concept maps, or it is defined implicitly by some code system known to the server. \n | |
| IN | conceptMap | type | 0..1 | ConceptMap | The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion. \n | |
| IN | conceptMapVersion | type | 0..1 | string | The identifier that is used to identify a specific version of the concept map to be used for the translation. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. \n | |
| IN | sourceCode | 0..1 | code | The code that is to be translated. If a code is provided, a system must be provided \n | ||
| IN | system | 0..1 | uri | The system for the code that is to be translated \n | ||
| IN | version | 0..1 | string | The version of the system, if one was provided in the source data \n | ||
| IN | sourceScope | 0..1 | uri | Limits the scope of the $translate operation to source codes (ConceptMap.group.element.code) that are members of this value set. \n | ||
| IN | sourceCoding | 0..1 | Coding | A coding to translate \n | ||
| IN | sourceCodeableConcept | 0..1 | CodeableConcept | A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses \n | ||
| IN | targetCode | 0..1 | uri | The target code that is to be translated to. If a code is provided, a system must be provided \n | ||
| IN | targetCoding | 0..1 | uri | A target coding to translate to \n | ||
| IN | targetCodeableConcept | 0..1 | uri | A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses \n | ||
| IN | targetScope | 0..1 | uri | Limits the scope of the $translate operation to target codes (ConceptMap.group.element.target.code) that are members of this value set. \n | ||
| IN | targetSystem | 0..1 | uri | identifies a target code system in which a mapping is sought. This parameter is an alternative to the targetScope parameter - only one is required. Searching for any translation to a target code system irrespective of the context (e.g. target valueset) may lead to unsafe results, and it is at the discretion of the server to decide when to support this operation \n | ||
| IN | dependency | 0..* | Data from another attribute that may help produce the correct mapping \n | |||
| IN | dependency.attribute | 0..1 | uri | The attribute for this dependency \n | ||
| IN | dependency.value | 0..1 | code | Coding | string | boolean | Quantity | The data value for this dependency \n | ||
| OUT | result | 1..1 | boolean | True if the concept could be translated successfully. The value can only be true if at least one returned match has a relationship other than 'not-related-to'. \n | ||
| OUT | message | 0..1 | string | Error details, for display to a human. If this is provided when result = true, the message carries hints and warnings (e.g. a note that the matches could be improved by providing additional detail) \n | ||
| OUT | match | 0..* | A concept in the target value set with a relationship. Note that there may be multiple matches of equal or differing relationships, and the matches may include the 'not-related-to' relationship value which means that there is no translation \n | |||
| OUT | match.relationship | 0..1 | code | A code indicating the relationship (e.g., equivalent) of the translation, using values from ConceptMapRelationship \n | ||
| OUT | match.concept | 0..1 | Coding | The translation outcome. Note that this would never have userSelected = true, since the process of translations implies that the user is not selecting the code (and only the client could know differently) \n | ||
| OUT | match.property | 0..* | A property of this mapping (may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation) \n | |||
| OUT | match.property.uri | 1..1 | uri | The uri that identifies the property \n | ||
| OUT | match.property.value | 1..1 | Coding | string | integer | boolean | dateTime | decimal | code | The value of the property \n | ||
| OUT | match.product | 0..* | A data value to go in an attribute that is the product of this mapping \n | |||
| OUT | match.product.attribute | 1..1 | uri | The attribute for this product \n | ||
| OUT | match.product.value | 1..1 | code | Coding | string | boolean | Quantity | The value for this product \n | ||
| OUT | match.dependsOn | 0..* | An data value in an additional attribute that this mapping depends on \n | |||
| OUT | match.dependsOn.attribute | 1..1 | uri | The attribute for this product \n | ||
| OUT | match.dependsOn.value | 1..1 | code | Coding | string | integer | boolean | dateTime | decimal | uri | id | The value for this product \n | ||
| OUT | match.originMap | 0..1 | uri | The canonical reference to the concept map from which this mapping comes from \n |
URL: [base]/CoverageEligibilityRequest/$submit
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | resource | 1..1 | Resource | An EligibilityRequest resource or Bundle of EligibilityRequests, either as individual EligibilityRequest resources or as Bundles each containing a single EligibilityRequest plus referenced resources. \n | ||
| OUT | return | 1..1 | Resource | An EligibilityResponse resource or Bundle of EligibilityResponse responses, either as individual EligibilityResponse resources or as Bundles each containing a single EligibilityResponse plus referenced resources. \n |
URL: [base]/DocumentReference/$docref
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | patient | 1..1 | id | The id of the patient resource located on the server on which this operation is executed. If there is no match, an empty Bundle is returned \n | ||
| IN | start | 0..1 | dateTime | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset. \n | ||
| IN | end | 0..1 | dateTime | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset. \n | ||
| IN | type | 0..1 | CodeableConcept | FHIR Document Type Codes (Required) | The type relates to document type e.g. for the LOINC code for a C-CDA Clinical Summary of Care (CCD) is 34133-9 (Summary of episode note). If no type is provided, the CCD document, if available, SHALL be in scope and all other document types MAY be in scope \n | |
| IN | on-demand | 0..1 | boolean | This on-demand parameter allows client to dictate whether they are requesting only 'on-demand' or both 'on-demand' and 'stable' documents (or delayed/deferred assembly) that meet the query parameters \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset"containing DocumentReference resources. \n |
The server either returns a search result containing a single DocumentReference,\nor it returns an error.
\nURL: [base]/DocumentReference/$generate
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | 1..1 | uri | The URL to the source document. This may be a general URL or a Binary or a Composition or a Bundle. \n | ||
| IN | persist | 0..1 | boolean | Whether to store the document at the document end-point (/Document) or not, once it is generated (default is for the server to decide). \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset"containing DocumentReference resource and may include a Binary. If the input url refers to another server, it is at the discretion of the server whether to retrieve it or return an error. \n |
The server either returns a search result containing a single document reference,\nor it returns an error.\nIf the URI refers to another server, it is at the discretion of the\nserver whether to retrieve it or return an error.
\nURL: [base]/Encounter/[id]/$everything
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _since | 0..1 | instant | Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time \n | ||
| IN | _type | 0..* | code | One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types \n | ||
| IN | _count | 0..1 | integer | See discussion below on the utility of paging through the results of the $everything operation \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset" \n |
The key differences between this operation and simply searching the encounter compartment are:
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single encounter, or determine whether the context has the rights to the nominated encounter, if there is one, or can determine an appropriate list of encouners to provide data for from the context of the request. If there is no nominated encounter (GET /[base]/Encounter/$everything) and the context is not associated with a single encounter record, the actual list of encounters is all encounters that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and encounter records is outside the scope of this specification (though see The Smart App Launch Implementation Guide.
\nWhen this operation is used to access multiple encounter records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the encounter since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\nURL: [base]/EpisodeOfCare/[id]/$everything
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _since | 0..1 | instant | Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time \n | ||
| IN | _type | 0..* | code | One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types \n | ||
| IN | _count | 0..1 | integer | See discussion below on the utility of paging through the results of the $everything operation \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset" \n |
The key differences between this operation and simply searching the episodeofcare compartment are:
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single episodeofcare, or determine whether the context has the rights to the nominated episodeofcare, if there is one, or can determine an appropriate list of episodeofcares to provide data for from the context of the request. If there is no nominated episodeofcare (GET /[base]/EpisodeOfCare/$everything) and the context is not associated with a single episodeofcare record, the actual list of episodeofcares is all episodeofcares that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and episodeofcare records is outside the scope of this specification (though see The Smart App Launch Implementation Guide.
\nWhen this operation is used to access multiple episodeofcare records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the episodeofcare since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\nURL: [base]/Group/[id]/$everything
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | start | 0..1 | date | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope. \n | ||
| IN | end | 0..1 | date | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope. \n | ||
| IN | _since | 0..1 | instant | Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time \n | ||
| IN | _type | 0..* | code | One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types \n | ||
| IN | _count | 0..1 | integer | See discussion below on the utility of paging through the results of the $everything operation \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset" \n |
The key differences between this operation and simply searching the group's patients compartment are:
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources.
\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a particular group, or determine whether the context has the rights to the nominated group, if there is one, or can determine an appropriate list of groups to provide data for from the context of the request. If there is no nominated group (GET /[base]/Group/$everything) and the context is not associated with a single group record, the actual list of groups is all groups that the user associated with the request has access to. In such cases, the server may choose to return an error rather than all the records (and is likely to do so, but not required to). Specifying the relationship between the context, a user and groups is outside the scope of this specification (though see The Smart App Launch Implementation Guide.
\nThe return bundle from this operation is usually rather a lot of data; servers typically choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the group since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\nURL: [base]/$data-requirements
URL: [base]/Library/[id]/$data-requirements
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | target | 0..1 | string | The target of the data requirements operation \n | ||
| OUT | return | 1..1 | Library | The result of the requirements gathering \n |
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for a given target resource. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the target resource and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)
\nURL: [base]/List/$find
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | patient | 1..1 | id | The id of a patient resource located on the server on which this operation is executed \n | ||
| IN | name | 1..1 | code | The code for the functional list that is being found \n |
Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly
\nURL: [base]/Measure/$care-gaps
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | periodStart | 1..1 | date | The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period s \n | ||
| IN | periodEnd | 1..1 | date | The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive \n | ||
| IN | topic | 1..1 | string | The topic to be used to determine which measures are considered for the care gaps report. Any measure with the given topic will be included in the report \n | ||
| IN | subject | 1..1 | string (reference) | Subject for which the care gaps report will be produced \n | ||
| OUT | return | 1..1 | Bundle | The result of the care gaps report will be returned as a document bundle with a MeasureReport entry for each included measure \n |
The effect of invoking this operation is to calculate a set of measures for a particular topic (e.g. Preventive Care and Screening) and return a document describing the results of each measure for the given subject. Note that it is up to the server to determine whether or not the generated care gaps report is persisted. If the server does not persist the results, the operation does not affect state and can be invoked with a GET
\nURL: [base]/Measure/$collect-data
URL: [base]/Measure/[id]/$collect-data
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | periodStart | 1..1 | date | The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period s \n | ||
| IN | periodEnd | 1..1 | date | The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive \n | ||
| IN | measure | type | 0..1 | string (reference) | The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance \n | |
| IN | subject | 0..1 | string (reference) | Subject for which the measure will be collected. If not specified, measure data will be collected for all subjects that meet the requirements of the measure. If specified, the measure will only be calculated for the referenced subject(s) \n | ||
| IN | practitioner | 0..1 | string (reference) | Practitioner for which the measure will be collected. If specified, measure data will be collected only for subjects that have a primary relationship to the identified practitioner \n | ||
| IN | lastReceivedOn | 0..1 | dateTime | The date the results of this measure were last received. This parameter used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios \n | ||
| OUT | measureReport | 1..1 | MeasureReport | A MeasureReport of type data-exchange detailing the results of the operation \n | ||
| OUT | resource | 0..* | Resource | The result resources that make up the data-of-interest for the measure \n |
The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource
\nURL: [base]/Measure/[id]/$data-requirements
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | periodStart | 1..1 | date | The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive \n | ||
| IN | periodEnd | 1..1 | date | The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive \n | ||
| OUT | return | 1..1 | Library | The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the measure \n |
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the measure. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the libraries referenced by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements). This operation defines what resources are subsequently referenced in the evaluatedResources element of the MeasureReport when submitting measure data
\nURL: [base]/Measure/$evaluate-measure
URL: [base]/Measure/[id]/$evaluate-measure
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | measure | type | 0..1 | Measure | The measure to evaluate. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required, or a url (and optionally version) must be supplied. \n | |
| IN | url | type | 0..1 | canonical | The url of the plan measure to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter (and optionally the version), or the measure parameter must be supplied \n | |
| IN | version | type | 0..1 | string | The version of the measure to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter may only be used if the url parameter is supplied. \n | |
| IN | subject | 0..1 | string (reference) | Subject for which the measure will be calculated. The subject may be a Patient, Practitioner, PractitionerRole, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the measure based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined \n | ||
| IN | periodStart | 1..1 | date | The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive \n | ||
| IN | periodEnd | 1..1 | date | The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive \n | ||
| IN | reportType | 0..1 | code | The type of measure report: individual, subject-list, or summary. If not specified, a default value of individual will be used if the subject parameter is supplied, otherwise, summary will be used. NOTE: Implementations should support the use of | ||
| IN | provider | 0..1 | string (reference) | The provider for which the report will be run. This may be a reference to a Practitioner, PractitionerRole, or Organization. If specified, the measure will be calculated for subjects that have a primary relationship to the identified provider. How this relationship is determined is implementation-specific. \n | ||
| IN | location | 0..1 | string (reference) | The location for which the report will be run. \n | ||
| IN | lastReceivedOn | 0..1 | dateTime | The date the results of this measure were last received. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report \n | ||
| IN | parameters | 0..1 | Parameters | Any input parameters for the evaluation. Parameters defined in this input will be made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the Using CQL topic of the Clinical Reasoning Module. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL. \n | ||
| OUT | return | 0..* | Bundle | The results of the measure calculation. The result of this operation will be a Bundle for each input subject, where the first entry of the Bundle is a MeasureReport representing the results of the calculation, and subsequent entries in the Bundle are resources created and/or evaluated as part of the calculation. See the MeasureReport resource for a complete description of the output of this operation. Note that implementations may choose to return a MeasureReport with a status of pending to indicate that the report is still being generated. In this case, the client can use a polling method to continually request the MeasureReport until the status is updated to complete \n |
The effect of invoking this operation is to calculate the measure for the given subject(s), or all subjects if no subject is supplied. For individual and subject-list reports, the result is a set of Bundles, one for each evaluated subject, where the first entry in each bundle is a MeasureReport resource, and subsequent entries in the Bundle are resources evaluated or created as part of the measure evaluation. For the summary report, the result of this operation is a single bundle with a single MeasureReport of type summary. Note that whether or not this operation affects the state of the server depends on whether the server persists the generated MeasureReport. If the MeasureReport is not persisted, this operation can be invoked with GET
\nURL: [base]/Measure/$submit-data
URL: [base]/Measure/[id]/$submit-data
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | measureReport | 1..1 | MeasureReport | The measure report being submitted \n | ||
| IN | resource | 0..* | Resource | The individual resources that make up the data-of-interest being submitted \n |
The effect of invoking this operation is that the submitted data is posted to the receiving system and can be used for subsequent calculation of the relevant quality measure. The data-of-interest for a measure can be determined by examining the measure definition, or by invoking the $data-requirements operation
\nURL: [base]/MedicinalProductDefinition/$everything
URL: [base]/MedicinalProductDefinition/[id]/$everything
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _since | 0..1 | instant | Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time \n | ||
| IN | _count | 0..1 | integer | See discussion below on the utility of paging through the results of the $everything operation \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset" \n |
The key differences between this operation and simply performing a search and using _include and _revinclude are:
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. It also makes for a much shorter and easier to construct query string. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the product data.
\nWhen this operation is used to access multiple product records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the product since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\nURL: [base]/$process-message
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | content | 1..1 | Bundle | The message to process (or, if using asynchronous messaging, it may be a response message to accept) \n | ||
| IN | async | 0..1 | boolean | If 'true' the message is processed using the asynchronous messaging pattern \n | ||
| IN | response-url | 0..1 | url | A URL to submit response messages to, if asynchronous messaging is being used, and if the MessageHeader.source.endpoint is not the appropriate place to submit responses \n | ||
| OUT | return | 0..1 | Bundle | A response message, if synchronous messaging is being used (mandatory in this case). For asynchronous messaging, there is no return value \n |
This operation does not use the parameters resource; the parameters "async" and "response-url" always go in the URL, if they are used, and the "content" parameter is always the body of the HTTP message.
\nWhen processing messages, a server may return one of several status codes:
\nThe following rules apply when using $process-message:
\nThe $process-message operation can be used by any HTTP end-point that accepts FHIR messages, not just FHIR RESTful servers.
\nIn order to ensure consistency of processing, the logical rules regarding processing of Bundle.id and message id SHALL be followed when messages are processed using this operation.
\nThe $process-message operation may be used synchronously, or asynchronously.
\nThe following rules apply when using the $process-message operation synchronously:
\nThe following rules apply when using the $process-message operation asynchronously:
\nURL: [base]/NamingSystem/$preferred-id
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | id | 1..1 | string | The server parses the provided identifier to see what type it is (e.g. a URI, an OID as a URI, a plain OID, or a v2 table 0396 code). If the server can't tell what type of identifier it is, it can try it as multiple types. It is an error if more than one system matches the provided identifier \n | ||
| IN | type | 1..1 | code | Naming System Identifier Type (Required) | ||
| IN | date | 0..1 | dateTime | If specified, the operation will indicate what the preferred identifier was on the specified date. If not specified, the operation will provide the preferred identifier as of 'now' \n | ||
| OUT | result | 1..1 | string | OIDs are return as plain OIDs (not the URI form). \n |
Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type (NamingSystem.uniqueId.type). If there is more than one identifier of the specified type (for the specified date), then the 'preferred' identifier will be returned. If there is only one identifier, that identifier will be returned even if it is not preferred. If there are multiple preferred identifiers or multiple identifiers with none marked as preferred, the system MAY return an error or may list all identifiers applicable for that date and period.
\nIf the server wishes, it can also look through all code systems and value sets it knows about when attempting to find the requested identifier.
\nURL: [base]/NamingSystem/$translate-id
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | id | 1..1 | string | The server parses the provided identifier to see what type it is (e.g. a URI, an OID as a URI, a plain OID, or a v2 table 0396 code). If the server can't tell what type of identifier it is, it can try it as multiple types. It is an error if more than one system matches the provided identifier \n | ||
| IN | sourceType | 1..1 | code | Naming System Identifier Type (Required) | ||
| IN | targetType | 1..1 | code | Naming System Identifier Type (Required) | ||
| IN | preferredOnly | 0..1 | boolean | If preferredOnly = true then return only the preferred identifier, or if preferredOnly = false then return all available ids. \n | ||
| IN | date | 0..1 | dateTime | If 'date' is supplied return only ids that have a validity period that includes that date. \n | ||
| OUT | result | 1..1 | boolean | True if the identifier could be translated successfully. \n | ||
| OUT | targetIdentifier | 0..* | string | The target identifer(s) of the requested type \n | ||
| OUT | targetIdentifer.preferred | 0..1 | boolean | Whether the target identifier is preferred. \n | ||
| OUT | targetIdentifier.period | 0..1 | Period | The perioid when the target identifier is valid. \n |
Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type (NamingSystem.uniqueId.type).
\nIf the server wishes, it can also look through all code systems and value sets it knows about when attempting to find the requested identifier
\nURL: [base]/Observation/$lastn
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | max | 0..1 | positiveInt |
| ||
| OUT | return | 1..1 | Bundle | The set of most recent N Observations that match the lastn query search criteria. \n |
The key differences between this query operation and simply searching Observation using the combination of _count and _sort parameters are:
This operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.
\nURL: [base]/Observation/$stats
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | subject | 1..1 | uri | The subject of the relevant Observations, which has the value of the Observation.subject.reference. E.g. 'Patient/123'. Reference can be to an absolute URL, but servers only perform stats on their own observations \n | ||
| IN | code | 0..* | string | The test code(s) upon which the statistics are being performed. Provide along with a system, or as a coding. For example, the LOINC code =\n2339-0 (Glucose [Mass/volume] in Blood) will evaluate all relevant Observations with this code in | ||
| IN | system | 0..1 | uri | The system for the code(s). Or provide a coding instead \n | ||
| IN | coding | 0..* | Coding | The test code upon which the statistics are being performed, as a Coding \n | ||
| IN | duration | 0..1 | decimal | The time period of interest given as hours. For example, the duration = "1" represents the last hour - the time period from on hour ago to now \n | ||
| IN | period | 0..1 | Period | The time period over which the calculations to be performed, if a duration is not provided \n | ||
| IN | statistic | 1..* | code | Statistics Code (Required) | average|max|min|count The statistical operations to be performed on the relevant operations. Multiple statistics operations can be specified. These codes are defined here \n | |
| IN | include | 0..1 | boolean | Whether to return the observations on which the statistics are based \n | ||
| IN | limit | 0..1 | positiveInt | If an include parameter is specified, a limit may also be specified to limit the number of source Observations returned. If the include parameter is absent or equal to "false" the limit parameter SHALL be ignored by the server \n | ||
| OUT | statistics | 1..* | Observation | A set of observations, one observation for each code, each containing one component for each statistic. The Observation.component.code contains the statistic, and is relative to the Observation.code and cannot be interpreted independently. The Observation will also contain a subject, effectivePeriod, and code reflecting the input parameters. The status is fixed to | ||
| OUT | source | 0..* | Observation | Source observations on which the statistics are based \n |
If modifier extensions are present in the Observation, they must be accounted for by implementers. A modifier extension may affect the observation.value in a way that it should be excluded from the from the calculations.
\nThis operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.
\nURL: [base]/Patient/$everything
URL: [base]/Patient/[id]/$everything
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | start | 0..1 | date | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope. \n | ||
| IN | end | 0..1 | date | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope. \n | ||
| IN | _since | 0..1 | instant | Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time \n | ||
| IN | _type | 0..* | code | One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absence of any specified types, the server returns all resource types \n | ||
| IN | _count | 0..1 | integer | See discussion below on the utility of paging through the results of the $everything operation \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset" \n |
The key differences between this operation and simply searching the patient compartment are:
\nThis frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the patient compartment.
\nIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one, or can determine an appropriate list of patients to provide data for from the context of the request. If there is no nominated patient (GET /[base]/Patient/$everything) and the context is not associated with a single patient record, the actual list of patients is all patients that the user associated with the request has access to. This may be all patients in the family that the patient has access to, or it may be all patients that a care provider has access to, or all patients on the entire record system. In such cases, the server may choose to return an error rather than all the records. Specifying the relationship between the context, a user and patient records is outside the scope of this specification (though see The Smart App Launch Implementation Guide.
\nWhen this operation is used to access multiple patient records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.
\nThe _since parameter is provided to support periodic queries to get additional information that has changed about the patient since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
\nURL: [base]/Patient/$match
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | resource | 1..1 | Resource | Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match). \n | ||
| IN | onlyCertainMatches | 0..1 | boolean | If there are multiple potential matches, then the match should not return the results with this flag set to true. When false, the server may return multiple results with each result graded accordingly. \n | ||
| IN | count | 0..1 | integer | The maximum number of records to return. If no value is provided, the server decides how many matches to return. Note that clients should be careful when using this, as it may prevent probable - and valid - matches from being returned \n | ||
| OUT | return | 1..1 | Bundle | The bundle type is "searchset" \nA bundle contain a set of Patient records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile) \n |
The response from an "mpi" query is a bundle containing patient records, ordered from most likely to least likely. If there are no patient matches, the MPI SHALL return an empty search set with no error, but may include an operation outcome with further advice regarding patient selection. All patient records SHALL have a search score from 0 to 1, where 1 is the most certain match, along with an extension "http://hl7.org/fhir/StructureDefinition/match-grade" that indicates the MPI's position on the match quality.
\nURL: [base]/Patient/$merge
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | source-patient | 0..1 | Reference | A direct resource reference to the source patient resource (this may include an identifier). \n | ||
| IN | source-patient-identifier | 0..* | Identifier | When source-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the source patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as part of a review by a user. \n | ||
| IN | target-patient | 0..1 | Reference | A direct resource reference to the target patient resource. \nThis is the surviving patient resource, the target for the merge. \n | ||
| IN | target-patient-identifier | 0..* | Identifier | When target-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the target patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as part of a review by a user. \n | ||
| IN | result-patient | 0..1 | Patient | The details of the Patient resource that is expected to be updated to complete with and must have the same patient.id and provided identifiers included. \nThis resource MUST have the link property included referencing the source patient resource. \nIt will be used to perform an update on the target patient resource. \nIn the absence of this parameter the servers should copy all identifiers from the source patient into the target patient, and include the link property (as shown in the example below). \nThis is often used when properties from the source patient are desired to be included in the target resource. \nThe receiving system may also apply other internal business rules onto the merge which may make the resource different from what is provided here. \n | ||
| IN | preview | 0..1 | boolean | If this is set to true then the merge will not be actually performed; an OperationOutcome will be returned in the Parameters response that will indicate that no merge has occurred and may include other diagnostic info if desired, such as the scale of the merge. \ne.g. Issue.details.text "Preview only Patient merge - no issues detected" \ne.g. Issue.diagnostics "Merge would update: 10 years of content or 120 resources" \nThe resulting target patient resource will also be returned in the result. \n | ||
| OUT | return | 1..1 | Parameters | The status of the response will be one of: \n
The Parameters resource will include: \n
|
There must be exactly 1 source patient, which may be identified by either the source-patient or source-patient-identifier parameters. Similarly, there must be exactly 1 target patient, identified by either the target-patient or target-patient-identifier parameters. In both cases, either a reference to the patient or a list of identifiers that can be used to identify the patient may be provided, but not both.
\nThe result-patient.id must be the same as the target patient reference (if the patient reference is provided as an input parameter).
\nIf a client needs the server to create a new patient merged from the 2 patient resources, the client should create a new patient record and then call the merge operation to merge each source patient resource into the newly created patient resource.
\nA server may decide to delete the source record, but this is not defined by the standard merge operation, and if this occurs then the target patient's link property will remain unchanged.
\nURL: [base]/PlanDefinition/$apply
URL: [base]/PlanDefinition/[id]/$apply
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | planDefinition | type | 0..1 | PlanDefinition | The plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required, or a url (and optionally version) must be supplied \n | |
| IN | url | type | 0..1 | canonical | The url of the plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter (and optionally the version), or the planDefinition parameter must be supplied \n | |
| IN | version | type | 0..1 | string | The version of the plan definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter may only be used if the url parameter is supplied. \n | |
| IN | subject | 1..* | string (reference) | The subject(s) that is/are the target of the plan to be applied. The subject may be a Patient, Practitioner, Organization, Location, Device, or Group. Subjects provided in this parameter will be resolved as the subject of the PlanDefinition based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined \n | ||
| IN | encounter | 0..1 | string (reference) | The encounter in context, if any \n | ||
| IN | practitioner | 0..1 | string (reference) | The practitioner applying the plan definition \n | ||
| IN | organization | 0..1 | string (reference) | The organization applying the plan definition \n | ||
| IN | userType | 0..1 | CodeableConcept | The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.) \n | ||
| IN | userLanguage | 0..1 | CodeableConcept | Preferred language of the person using the system \n | ||
| IN | userTaskContext | 0..1 | CodeableConcept | The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources \n | ||
| IN | setting | 0..1 | CodeableConcept | The current setting of the request (inpatient, outpatient, etc.) \n | ||
| IN | settingContext | 0..1 | CodeableConcept | Additional detail about the setting of the request, if any \n | ||
| OUT | return | 0..* | Bundle | A Bundle for each input subject that is the result of applying the plan definition to that subject \n |
The result of this operation is a Bundle for each subject, where the Bundle contains as its first entry a RequestOrchestration that is the direct result of applying the PlanDefinition to that subject, and any subsequent entries in the Bundle are resources that were created or updated as part of that process. The RequestOrchestration will have actions for each of the applicable actions in the plan based on evaluating the applicability condition in context. For each applicable action, the definition is applied as described in the $apply operation of the ActivityDefinition resource, and the resulting resource is added as an entry to the Bundle. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation. In addition, parameters to the $apply operation are available within dynamicValue expressions as context variables, accessible by the name of the parameter, prefixed with a percent (%) symbol. For a more detailed description, refer to the PlanDefinition and ActivityDefinition resource documentation. Note that result of this operation is transient (i.e. none of the resources created by the operation are persisted in the server, they are all returned as entries in the result Bundle(s)). The result effectively represents a proposed set of activities, and it is up to the caller to determine whether and how those activities are actually carried out and/or persisted.
\nURL: [base]/PlanDefinition/[id]/$data-requirements
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| OUT | return | 1..1 | Library | The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the plan definition \n |
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the plan definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the plan definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)
\nURL: [base]/Resource/[id]/$add
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | additions | 1..1 | Resource | Resource containing content to add. See Operations for Large Resources. \n | ||
| OUT | return | 0..1 | Resource | Resource containing content added. See Operations for Large Resources. \n |
URL: [base]/$convert
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | resource | 1..1 | Resource | The resource that is to be converted \n | ||
| OUT | return | 1..1 | Resource | The resource after conversion \n |
While the primary use of this operation is simple - converting a resource from one format to another, there are many potential uses including:
\nThese variants would all be associated with parameters that define and control these kind of conversions, though such parameters are not defined at this time. In the absence of any parameters, simple format conversion is all that will occur.
\nFor this reason, implementers should be aware that:
\nreturn resource type may be different from the resource parameter resource type (for example, it might be a bundle)Implementers are encouraged to provide feedback to HL7 about their use of this operation
\nURL: [base]/Resource/[id]/$filter
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | probes | 1..1 | Resource | Resource containing content that acts as a filter. See Operations for Large Resources. \n | ||
| OUT | return | 0..1 | Resource | Resource containing content matching the filter. See Operations for Large Resources. \n |
URL: [base]/Resource/[id]/$graph
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | graph | 1..1 | uri | Servers MAY choose to allow any graph definition to be specified, but MAY require that the client choose a graph definition from a specific list of known supported definitions. The server is not required to support a formal definition of the graph on the end point \n | ||
| OUT | result | 1..1 | Bundle | The set of resources that were in the graph based on the provided definition \n |
URL: [base]/$graphql
URL: [base]/Resource/[id]/$graphql
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | query | 1..1 | string | |||
| OUT | result | 1..1 | Binary | The content is always returned as application/json; this SHOULD be specified in the Accept header \n |
URL: [base]/$meta
URL: [base]/Resource/$meta
URL: [base]/Resource/[id]/$meta
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| OUT | return | 1..1 | Meta | The meta returned by the operation \n |
At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principal use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't). At the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons
\nURL: [base]/Resource/[id]/$meta-add
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | meta | 1..1 | Meta | Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. The identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles, matching is based on the full URL \n | ||
| OUT | return | 1..1 | Meta | Resulting meta for the resource \n |
URL: [base]/Resource/[id]/$meta-delete
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | meta | 1..1 | Meta | Profiles, tags, and security labels to delete from the existing resource. It is not an error if these tags, profiles, and labels do not exist. The identity of a tag or security label is the system+code. When matching existing tags during deletion, version and display are ignored. For profiles, matching is based on the full URL \n | ||
| OUT | return | 1..1 | Meta | Resulting meta for the resource \n |
URL: [base]/Resource/[id]/$remove
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | removals | 1..1 | Resource | Resource containing content to remove. See Operations for Large Resources. \n | ||
| OUT | return | 0..1 | Resource | Resource containing content removed. See Operations for Large Resources. \n |
URL: [base]/Resource/$validate
URL: [base]/Resource/[id]/$validate
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | resource | 0..1 | Resource | Must be present unless the mode is "delete" \n | ||
| IN | mode | 0..1 | code | Resource Validation Mode (Required) | Default is 'no action'; (e.g. general validation) \n | |
| IN | profile | 0..1 | canonical | If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate against the nominated profile, it SHALL return an error \n | ||
| IN | usageContext TU | 0..* | UsageContext | Indicates an implementation context that applies to this validation. Influences which additionalBindings are relevant. NOTE: Expectations around subsumption testing, etc. are not yet defined and may be server-specific. \n | ||
| OUT | return | 1..1 | OperationOutcome | If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below) \n |
This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to successfully perform an actual create, update or delete after the validation operation completes.
\nThis operation returns a 200 Ok provided that it was possible to perform validation, irrespective of whether validation issues were found. However, it is possible that certain errors in the validated content (e.g. invalid character set, broken JSON, etc.) may cause the overall validation operation to fail with a 4xx or 5xx series response.
\nNote: the correct behavior of validation with regard to language (especially for Coding.display) is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases
\nFuture versions of this specifcation may add additional validation parameters. A candidate list is maintained with the FHIR Validator Documentation
\nURL: [base]/SpecimenDefinition/$apply
URL: [base]/SpecimenDefinition/[id]/$apply
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | specimenDefinition | type | 0..1 | SpecimenDefinition | The specimen definition to be applied. If the operation is invoked at the instance level, this parameter is not allowed; if the operation is invoked at the type level, this parameter is required \n | |
| IN | subject | 1..* | string (reference) | The subject(s) that is/are the target of the Specimen instance to be created. The subject may be a Patient, Group, Device, Substance or Location. Subjects provided in this parameter will be resolved as the subject of the Specimen based on the type of the subject. If multiple subjects of the same type are provided, the behavior is implementation-defined \n | ||
| IN | collector | 0..1 | string (reference) | The practitioner (or practitioner role) that is collecting the specimen \n | ||
| IN | userType | 0..1 | CodeableConcept | The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.) \n | ||
| IN | userLanguage | 0..1 | CodeableConcept | Preferred language of the person using the system \n | ||
| IN | userTaskContext | 0..1 | CodeableConcept | The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources \n | ||
| IN | setting | 0..1 | CodeableConcept | The current setting of the request (inpatient, outpatient, etc.) \n | ||
| IN | settingContext | 0..1 | CodeableConcept | Additional detail about the setting of the request, if any \n | ||
| OUT | return | 1..1 | Specimen | The Specimen resource that is the result of applying the specimen definition \n |
The result of this operation is a Specimen resource based on the definition of the specimen as described in the SpecimenDefinition resource and the supplied parameters.
\nURL: [base]/StructureDefinition/$questionnaire
URL: [base]/StructureDefinition/[id]/$questionnaire
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | identifier | 0..1 | Identifier | A logical identifier (i.e. 'StructureDefinition.identifier''). The server must know the StructureDefinition or be able to retrieve it from other known repositories. \n | ||
| IN | profile | 0..1 | StructureDefinition | The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion \n | ||
| IN | url | type | 0..1 | canonical | The StructureDefinition's official URL (i.e. 'StructureDefinition.url'). The server must know the StructureDefinition or be able to retrieve it from other known repositories. \n | |
| IN | supportedOnly | 0..1 | boolean | If true, the questionnaire will only include those elements marked as "mustSupport='true'" in the StructureDefinition. \n | ||
| OUT | return | 1..1 | Questionnaire | The questionnaire form generated based on the StructureDefinition. \n |
Open Issue: Ideally, extensions should be populated in the generated Questionnaire that will support taking QuestionnaireResponse resources generated from the Questionnaire and turning them back into the appropriate resources.
\nURL: [base]/StructureDefinition/$snapshot
URL: [base]/StructureDefinition/[id]/$snapshot
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | definition | type | 0..1 | StructureDefinition | The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion \n | |
| IN | url | type | 0..1 | string (token) | The StructureDefinition's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories. \n | |
| OUT | return | 1..1 | StructureDefinition | The structure definition with a snapshot \n |
URL: [base]/StructureMap/$transform
URL: [base]/StructureMap/[id]/$transform
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | source | type | 0..1 | uri | The structure map to apply. This is only needed if the operation is invoked at the resource level and no structureMap has been provided. If the $transform operation is invoked on a particular structure map, this will be ignored by the server \n | |
| IN | sourceMap | 0..1 | StructureMap | The structure map to apply. This is only needed when the operation is invoked at the resource level and no URI has been provided. \n | ||
| IN | supportingMap | 0..* | StructureMap | StructureMap resources that support the source map. If a source URL is provided, the map can be provided in this parameter (or it can be provided as sourceMap). \n | ||
| IN | srcMap | 0..* | string | The same as structureMap, but the resource is provided in the mapping language rather than as a structureMap. \n | ||
| IN | content | 1..1 | Resource | The logical content to transform \n | ||
| OUT | return | 1..1 | Resource | The result of the transform \n |
The input and return are specified as 'Resources'. In most usage of the $transform operation, either the input or return content is not a valid FHIR resource. In these cases, the return type is actually a Binary resource. For this operation, the Binary resources may be encoded directly, using a mime-type, as shown in the example. Note: this specification does not yet address the means by which the servers may know the correct mime types for the various content involved
\nURL: [base]/Subscription/[id]/$events
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | eventsSinceNumber | 0..1 | integer64 | The starting event number, inclusive of this event (lower bound). \n | ||
| IN | eventsUntilNumber | 0..1 | integer64 | The ending event number, inclusive of this event (upper bound). \n | ||
| IN | content | 0..1 | code | Subscription Payload Content (Required) | Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored. \n | |
| OUT | return | 1..1 | Bundle | The operation returns a valid notification bundle, with the first entry being a SubscriptionStatus resource. The bundle type is "subscription-notification". \n |
URL: [base]/Subscription/$get-ws-binding-token
URL: [base]/Subscription/[id]/$get-ws-binding-token
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | id | type | 0..* | id | At the Instance level, this parameter is ignored. At the Resource level, one or more parameters containing a FHIR id for a Subscription to get a token for. In the absence of any specified ids, the server may either return a token for all Subscriptions available to the caller with a channel-type of websocket or fail the request. \n | |
| OUT | token | 1..1 | string | An access token that a client may use to show authorization during a websocket connection. The security details of the token are implementation-dependent and beyond the scope of this operation definition. \n | ||
| OUT | expiration | 1..1 | dateTime | The date and time this token is valid until. \n | ||
| OUT | subscription | 0..* | string | The subscriptions this token is valid for. \n | ||
| OUT | websocket-url | 1..1 | url | The URL the client should use to connect to Websockets. \n |
URL: [base]/Subscription/$status
URL: [base]/Subscription/[id]/$status
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | id | type | 0..* | id | At the Instance level, this parameter is ignored. At the Resource level, one or more FHIR ids to Subscription resources to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., "id1" OR "id2"). \n | |
| IN | status | type | 0..* | code | Subscription Status (Required) | At the Instance level, this parameter is ignored. At the Resource level, a Subscription status code to filter by (e.g., "active"). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., "error" OR "off"). \n |
| OUT | return | 1..1 | Bundle | The operation returns a bundle containing zero or more SubscriptionStatus resources, one per Subscription in the request that was found. The Bundle type is "searchset". \n |
URL: [base]/ValueSet/$expand
URL: [base]/ValueSet/[id]/$expand
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | type | 0..1 | uri | A canonical reference to a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server \n | |
| IN | valueSet | type | 0..1 | ValueSet | The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion \n | |
| IN | valueSetVersion | type | 0..1 | string | The identifier that is used to identify a specific version of the value set to be used when generating the expansion. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. \n | |
| IN | context | 0..1 | uri | The context of the value set, so that the server can resolve this to a value set to expand. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time \n | ||
| IN | contextDirection | 0..1 | code | If a context is provided, a context direction may also be provided. Valid values are: \n
The purpose is to inform the server whether to use the value set associated with the context for reading or writing purposes (note: for most elements, this is the same value set, but there are a few elements where the reading and writing value sets are different) \n | ||
| IN | filter | 0..1 | string | A text filter that is applied to restrict the codes that are returned (this is useful in a UI context). The interpretation of this is delegated to the server in order to allow to determine the most optimal search approach for the context. The server can document the way this parameter works in TerminologyCapabilities..expansion.textFilter. Typical usage of this parameter includes functionality like: \n
Text Search engines such as Lucene or Solr, long with their considerable functionality, might also be used. The optional text search might also be code system specific, and servers might have different implementations for different code systems \n | ||
| IN | date | 0..1 | dateTime | The date for which the expansion should be generated. if a date is provided, it means that the server should use the value set / code system definitions as they were on the given date, or return an error if this is not possible. Normally, the date is the current conditions (which is the default value) but under some circumstances, systems need to generate an expansion as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy. \n | ||
| IN | offset | 0..1 | integer | Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages) \n | ||
| IN | count | 0..1 | integer | Paging support - how many codes should be provided in a partial page view. Paging only applies to flat expansions - servers ignore paging if the expansion is not flat. If count = 0, the client is asking how large the expansion is. Servers SHOULD honor this request for hierarchical expansions as well, and simply return the overall count \n | ||
| IN | includeDesignations | 0..1 | boolean | Controls whether concept designations are to be included or excluded in value set expansions \n | ||
| IN | designation | 0..* | string | A token that specifies a system+code that is either a use or a language. Designations that match by language or use are included in the expansion. If no designation is specified, it is at the server discretion which designations to return \n | ||
| IN | includeDefinition | 0..1 | boolean | Controls whether the value set definition is included or excluded in value set expansions \n | ||
| IN | activeOnly | 0..1 | boolean | Controls whether inactive concepts are included or excluded in value set expansions. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them \n | ||
| IN | useSupplement | 0..* | canonical | The supplement must be used when performing an expansion. Use of this parameter should result in $expand behaving the same way as if the supplements were included in the value set definition using the http://hl7.org/fhir/StructureDefinition/valueset-supplement \n | ||
| IN | excludeNested | 0..1 | boolean | Controls whether or not the value set expansion may nest codes or not (i.e. ValueSet.expansion.contains.contains). If excludeNested is set to true, the expansion MUST be flat (no nesting). If excludeNested is set to false (default), however, nesting is possible but not required \n | ||
| IN | excludeNotForUI | 0..1 | boolean | Controls whether or not the value set expansion might include \n
One purpose of such concepts is helping a user navigate through the list efficiently. If excludeNotForUI is set to true, the concepts as described above will be excluded from the expansion. If excludeNotForUI is set to false (default), all concepts as described above may be part of the expansion. In the FHIR Specification itself, the value set expansions are generated with excludeNotForUI = false, and the expansions used when generating schema / code etc., or performing validation, are all excludeNotForUI = true. \n | ||
| IN | excludePostCoordinated | 0..1 | boolean | Controls whether or not the value set expansion includes post coordinated codes \n | ||
| IN | displayLanguage | 0..1 | code | Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display \n | ||
| IN | property | 0..* | string | A request to return a particular property in the expansion. The returned property may include subproperties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. Note that property names can clash, so using a URI is recommended. The special value '*' means all properties and their sub-properties known to the server \n | ||
| IN | exclude-system | 0..* | canonical | Code system, or a particular version of a code system to be excluded from the value set expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56 \n | ||
| IN | system-version | 0..* | canonical | Specifies a version to use for a system, if the value set does not specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56 \n | ||
| IN | check-system-version | 0..* | canonical | Edge Case: Specifies a version to use for a system. If a value set specifies a different version, an error is returned instead of the expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56 \n | ||
| IN | force-system-version | 0..* | canonical | Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the value set (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters \n | ||
| OUT | return | 1..1 | ValueSet | The result of the expansion. Servers generating expansions SHOULD ensure that all the parameters that affect the contents of the expansion are recorded in the ValueSet.expansion.parameter list \n |
The value set expansion returned by this query should be treated as a transient result that will change over time (whether it does or not depends on how the value set is specified), so applications should repeat the operation each time the value set is used.
\nWhen available, ValueSet.status and ValueSet.version from the ValueSet resource instance which contains the definition SHALL be persisted to the ValueSet resource instance which contains the expansion.
\nIf the expansion is too large (at the discretion of the server), the server MAY return an error (OperationOutcome with code too-costly). Clients can work through large flat expansions in a set of pages (partial views of the full expansion) instead of just getting the full expansion in a single exchange by using offset and count parameters, or use the count parameter to request a subset of the expansion for limited purposes. Servers are not obliged to support paging, but if they do, SHALL support both the offset and count parameters. Hierarchical expansions are not subject to paging and servers simply return the entire expansion.
\nDifferent servers may return different results from expanding a value set for the following reasons:
\nWhen a server cannot correctly expand a value set because it does not fully understand the code systems (e.g. it has the wrong version, or incomplete definitions) then it SHALL return an error. If the value set itself is unbounded due to the inclusion of post-coordinated value sets (e.g. SNOMED CT, UCUM), then the extension http://hl7.org/fhir/StructureDefinition/valueset-unclosed can be used to indicate that the expansion is incomplete
\nURL: [base]/ValueSet/$validate-code
URL: [base]/ValueSet/[id]/$validate-code
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | type | 0..1 | uri | Value set Canonical URL. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server \n | |
| IN | context | 0..1 | uri | The context of the value set, so that the server can resolve this to a value set to validate against. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time \n | ||
| IN | valueSet | type | 0..1 | ValueSet | The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion. This parameter is used when the client wants the server to expand a value set that is not stored on the server \n | |
| IN | valueSetVersion | type | 0..1 | string | The identifier that is used to identify a specific version of the value set to be used when validating the code. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. \n | |
| IN | code | 0..1 | code | The code that is to be validated. If a code is provided, a system or a context must be provided (if a context is provided, then the server SHALL ensure that the code is not ambiguous without a system) \n | ||
| IN | system | 0..1 | uri | The system for the code that is to be validated \n | ||
| IN | systemVersion | 0..1 | string | The version of the system, if one was provided in the source data \n | ||
| IN | display | 0..1 | string | The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name using the display parameter in the outcome. Whether displays are case sensitive is code system dependent \n | ||
| IN | coding | 0..1 | Coding | A coding to validate \n | ||
| IN | codeableConcept | 0..1 | CodeableConcept | A full codeableConcept to validate. The server returns true if one of the coding values is in the value set, and may also validate that the codings are not in conflict with each other if more than one is present \n | ||
| IN | date | 0..1 | dateTime | The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy. \n | ||
| IN | abstract | 0..1 | boolean | If this parameter has a value of true or the parametter is ommitted, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid. \nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used as a 'concrete' concept to in an actual patient/care/process record. This language is borrowed from object-orientated theory where 'abstract' entities are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropriate to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context. \n | ||
| IN | displayLanguage | 0..1 | code | Specifies the language to be used for description when validating the display property \n | ||
| IN | useSupplement | 0..* | canonical | The supplement must be used when validating the code. Use of this parameter should result in $validate-code behaving the same way as if the supplements were included in the value set definition using the http://hl7.org/fhir/StructureDefinition/valueset-supplement \n | ||
| OUT | result | 1..1 | boolean | True if the concept details supplied are valid \n | ||
| OUT | message | 0..1 | string | Error details, if result = false. If this is provided when result = true, the message carries hints and warnings \n | ||
| OUT | display | 0..1 | string | A valid display for the concept if the system wishes to display this to a user \n | ||
| OUT | code | 0..1 | code | The code that was validated \n | ||
| OUT | system | 0..1 | uri | The system for the code that was validated \n | ||
| OUT | version | 0..1 | string | The version of the system of the code that was validated \n | ||
| OUT | codeableConcept | 0..1 | CodeableConcept | A codeableConcept containing codings for all the validated codes \n | ||
| OUT | issues | 0..1 | OperationOutcome | List of itemised issues with paths constrained to simple FHIRPath. Examples are CodeableConcept, CodeableConcept.coding[0], CodeableConcept.coding[1].display, or Coding.display \n |
Note: the correct behavior of validation with regard to language for Coding.display items is currently undefined, and further development and testing may lead to specific requirements or recommendations in subsequent releases
\n| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| «A»N | Base | Base Resource Elements defined in Ancestors: | ||||||
| Σ | 0..1 | id | Logical id of this artifact | |||||
| Σ | 0..1 | Meta | Metadata about the resource | |||||
| ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||
| 0..1 | code | Language of the resource content Binding: All Languages (Required)
| ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Tracks balance, charges, for patient or cost center Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Account number | |
| ?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: Account Status (Required) | |
| Σ | 0..1 | CodeableConcept | Tracks the lifecycle of the account through the billing process Binding: Example Account Billing Statuses (Example) | |
| Σ | 0..1 | CodeableConcept | E.g. patient, expense, depreciation Binding: Account Types (Example) | |
| Σ | 0..1 | string | Human-readable label | |
| Σ | 0..* | Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) | The entity that caused the expenses | |
| Σ | 0..1 | Period | Transaction window | |
| Σ | 0..* | BackboneElement | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account | |
| Σ | 1..1 | Reference(Coverage) | The party(s), such as insurances, that may contribute to the payment of this account | |
| Σ | 0..1 | positiveInt | The priority of the coverage in the context of this account | |
| Σ | 0..1 | Reference(Organization) | Entity managing the Account | |
| Σ | 0..1 | markdown | Explanation of purpose/use | |
| 0..* | BackboneElement | The parties ultimately responsible for balancing the Account | ||
| 1..1 | Reference(Patient | RelatedPerson | Organization) | Responsible entity | ||
| 0..1 | boolean | Credit or other hold applied | ||
| 0..1 | Period | Guarantee account during | ||
| ΣCTU | 0..* | BackboneElement | The list of diagnoses relevant to this account + Rule: The dateOfDiagnosis is not valid when using a reference to a diagnosis | |
| 0..1 | positiveInt | Ranking of the diagnosis (for each type) | ||
| ΣC | 1..1 | CodeableReference(Condition) | The diagnosis relevant to the account Binding: Condition/Problem/Diagnosis Codes (Example) | |
| C | 0..1 | dateTime | Date of the diagnosis (when coded diagnosis) | |
| 0..* | CodeableConcept | Type that this diagnosis has relevant to the account (e.g. admission, billing, discharge …) Binding: Encounter Diagnosis Use (Preferred) | ||
| 0..1 | boolean | Diagnosis present on Admission | ||
| 0..* | CodeableConcept | Package Code specific for billing Binding: diagnosis-package-code (Example) | ||
| ΣCTU | 0..* | BackboneElement | The list of procedures relevant to this account + Rule: The dateOfService is not valid when using a reference to a procedure | |
| 0..1 | positiveInt | Ranking of the procedure (for each type) | ||
| ΣC | 1..1 | CodeableReference(Procedure) | The procedure relevant to the account Binding: Procedure Codes (SNOMED CT) (Example) | |
| C | 0..1 | dateTime | Date of the procedure (when coded procedure) | |
| 0..* | CodeableConcept | How this procedure value should be used in charging the account Binding: procedure-type (Example) | ||
| 0..* | CodeableConcept | Package Code specific for billing Binding: procedure-package-code (Example) | ||
| Σ | 0..* | Reference(Device) | Any devices that were associated with the procedure | |
| 0..* | BackboneElement | Other associated accounts related to this account | ||
| 0..1 | CodeableConcept | Relationship of the associated Account Binding: Account Relationship (Example) | ||
| 1..1 | Reference(Account) | Reference to an associated Account | ||
| 0..1 | CodeableConcept | The base or default currency Binding: Currencies (Required) | ||
| 0..* | BackboneElement | Calculated account balance(s) | ||
| 0..1 | CodeableConcept | Who is expected to pay this part of the balance Binding: Account Aggregate (Extensible) | ||
| 0..1 | CodeableConcept | current | 30 | 60 | 90 | 120 Binding: Account Balance Term (Extensible) | ||
| 0..1 | boolean | Estimated balance | ||
| 1..1 | Money | Calculated amount | ||
| 0..1 | instant | Time the balance amount was calculated | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | The definition of a specific activity to be taken, independent of any particular patient or context + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the activity definition | |
| Σ | 0..1 | string | Business version of the activity definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this activity definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this activity definition (human friendly) | |
| T | 0..1 | string | Subordinate title of the activity definition | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| 0..1 | Type of individual the activity definition is intended for Binding: Participant Resource Types (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | ||||
| canonical(EvidenceVariable) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the activity definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this activity definition is defined | |
| T | 0..1 | markdown | Describes the clinical usage of the activity definition | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the activity definition was approved by publisher | ||
| 0..1 | date | When the activity definition was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the activity definition is expected to be used | |
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the content | ||
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| 0..* | ContactDetail | Who endorsed the content | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| 0..* | canonical(Library) | Logic used by the activity definition | ||
| Σ | 0..1 | code | Kind of resource Binding: Request Resource Types (Required) | |
| 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | ||
| Σ | 0..1 | CodeableConcept | Detail type of activity Binding: Procedure Codes (SNOMED CT) (Example) | |
| 0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (Required) | ||
| 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | ||
| ?!Σ | 0..1 | boolean | True if the activity should not be performed | |
| 0..1 | When activity is to occur | |||
| Timing | ||||
| Age | ||||
| Range | ||||
| Duration | ||||
| Σ | 0..1 | Preconditions for service Binding: SNOMED CT Medication As Needed Reason Codes (Example) | ||
| boolean | ||||
| CodeableConcept | ||||
| 0..1 | CodeableReference(Location) | Where it should happen | ||
| 0..* | BackboneElement | Who should participate in the action | ||
| 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: Action Participant Type (Required) | ||
| 0..1 | canonical(CapabilityStatement) | Who or what can participate | ||
| 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | ||
| 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: Action Participant Role (Example) | ||
| 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: Action Participant Function (Example) | ||
| 0..1 | What's administered/supplied Binding: SNOMED CT Medication Codes (Example) | |||
| Reference(Medication | Ingredient | Substance | SubstanceDefinition) | ||||
| CodeableConcept | ||||
| 0..1 | SimpleQuantity | How much is administered/consumed/supplied | ||
| 0..* | Dosage | Detailed dosage instructions | ||
| 0..* | CodeableConcept | What part of body to perform on Binding: SNOMED CT Body Structures (Example) | ||
| 0..* | canonical(SpecimenDefinition) | What specimens are required to perform this action | ||
| 0..* | canonical(ObservationDefinition) | What observations are required to perform this action | ||
| 0..* | canonical(ObservationDefinition) | What observations must be produced by this action | ||
| 0..1 | canonical(StructureMap) | Transform to apply the template | ||
| 0..* | BackboneElement | Dynamic aspects of the definition | ||
| 1..1 | string | The path to the element to be set dynamically | ||
| 1..1 | Expression | An expression that provides the dynamic value for the customization | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An application that exchanges data + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this actor definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the actor definition (business identifier) | |
| Σ | 0..1 | string | Business version of the actor definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this actor definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this actor definition (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the actor | |
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for actor definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this actor definition is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| Σ | 1..1 | code | person | system Binding: Example Scenario Actor Type (Required) | |
| T | 0..1 | markdown | Functionality associated with the actor | |
| 0..* | url | Reference to more information about the actor | ||
| 0..1 | canonical(CapabilityStatement) | CapabilityStatement for the actor (if applicable) | ||
| 0..* | canonical(ActorDefinition) | Definition of this actor in another context / IG | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A medicinal product in the final form, suitable for administration - after any mixing of multiple components + Rule: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | An identifier for the administrable product | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| ΣC | 0..* | Reference(MedicinalProductDefinition) | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product | |
| Σ | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: Administrable Dose Form (Example) | |
| Σ | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Unit Of Presentation (Example) | |
| Σ | 0..* | Reference(ManufacturedItemDefinition) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form | |
| Σ | 0..* | CodeableConcept | The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton, or using by incoming references from the Ingredient resource Binding: SNOMED CT Substance Codes (Example) | |
| Σ | 0..1 | Reference(DeviceDefinition) | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product | |
| 0..1 | markdown | A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed | ||
| Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: Product Characteristic (Example) | |
| Σ | 0..1 | A value for the characteristic | ||
| CodeableConcept | ||||
| Quantity | ||||
| date | ||||
| boolean | ||||
| markdown | ||||
| Attachment | ||||
| Reference(Binary) | ||||
| Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (Required) | |
| Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body | |
| Σ | 1..1 | CodeableConcept | Coded expression for the route Binding: SNOMED CT Route Codes (Example) | |
| Σ | 0..1 | Quantity | The first dose (dose quantity) administered can be specified for the product | |
| Σ | 0..1 | Quantity | The maximum single dose that can be administered | |
| Σ | 0..1 | Quantity | The maximum dose quantity to be administered in any one 24-h period | |
| Σ | 0..1 | Ratio | The maximum dose per treatment period that can be administered | |
| Σ | 0..1 | Duration | The maximum treatment period during which the product can be administered | |
| Σ | 0..* | BackboneElement | A species for which this route applies | |
| Σ | 1..1 | CodeableConcept | Coded expression for the species Binding: Target Species (Example) | |
| Σ | 0..* | BackboneElement | A species specific time during which consumption of animal product is not appropriate | |
| Σ | 1..1 | CodeableConcept | The type of tissue for which the withdrawal period applies, e.g. meat, milk Binding: Animal Tissue Type (Example) | |
| Σ | 1..1 | Quantity | A value for the time | |
| Σ | 0..1 | string | Extra information about the withdrawal period | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An event that may be related to unintended effects on a patient or research participant Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for the event | |
| ?!Σ | 1..1 | code | in-progress | completed | entered-in-error | unknown Binding: Adverse Event Status (Required) | |
| ?!Σ | 1..1 | code | actual | potential Binding: Adverse Event Actuality (Required) | |
| Σ | 0..* | CodeableConcept | wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site Binding: Adverse Event Category (Example) | |
| Σ | 0..1 | CodeableConcept | Event or incident that occurred or was averted Binding: AdverseEvent Type (Example) | |
| Σ | 1..1 | Reference(Patient | Group | Practitioner | RelatedPerson | ResearchSubject) | Subject impacted by event | |
| Σ | 0..1 | Reference(Encounter) | The Encounter associated with the start of the AdverseEvent | |
| Σ | 0..1 | When the event occurred | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| Σ | 0..1 | dateTime | When the event was detected | |
| Σ | 0..1 | dateTime | When the event was recorded | |
| Σ | 0..* | Reference(Condition | Observation) | Effect on the subject due to this event | |
| Σ | 0..1 | Reference(Location) | Location where adverse event occurred | |
| Σ | 0..1 | CodeableConcept | Seriousness or gravity of the event Binding: Adverse Event Seriousness (Example) | |
| Σ | 0..* | CodeableConcept | Type of outcome from the adverse event Binding: AdverseEvent Outcome (Example) | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | ResearchSubject) | Who recorded the adverse event | |
| Σ | 0..* | BackboneElement | Who was involved in the adverse event or the potential adverse event and what they did | |
| Σ | 0..1 | CodeableConcept | Type of involvement Binding: AdverseEvent Participant Function (Example) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | ResearchSubject) | Who was involved in the adverse event or the potential adverse event | |
| Σ | 0..* | Reference(ResearchStudy) | Research study that the subject is enrolled in | |
| 0..1 | boolean | Considered likely or probable or anticipated in the research study | ||
| Σ | 0..* | BackboneElement | The suspected agent causing the adverse event | |
| Σ | 1..1 | Refers to the specific entity that caused the adverse event | ||
| CodeableConcept | ||||
| Reference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device | BiologicallyDerivedProduct | ResearchStudy) | ||||
| Σ | 0..1 | BackboneElement | Information on the possible cause of the event | |
| Σ | 0..1 | CodeableConcept | Method of evaluating the relatedness of the suspected entity to the event Binding: Adverse Event Causality Method (Example) | |
| Σ | 0..1 | CodeableConcept | Result of the assessment regarding the relatedness of the suspected entity to the event Binding: Adverse Event Causality Assessment (Example) | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | ResearchSubject) | Author of the information on the possible cause of the event | |
| Σ | 0..* | BackboneElement | Contributing factors suspected to have increased the probability or severity of the adverse event | |
| Σ | 1..1 | Item suspected to have increased the probability or severity of the adverse event Binding: AdverseEvent Contributing Factor (Example) | ||
| Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Device | DeviceUsage | DocumentReference | MedicationAdministration | MedicationStatement) | ||||
| CodeableConcept | ||||
| Σ | 0..* | BackboneElement | Preventive actions that contributed to avoiding the adverse event | |
| Σ | 1..1 | Action that contributed to avoiding the adverse event Binding: AdverseEvent Preventive Action (Example) | ||
| Reference(Immunization | Procedure | DocumentReference | MedicationAdministration | MedicationRequest) | ||||
| CodeableConcept | ||||
| Σ | 0..* | BackboneElement | Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm | |
| Σ | 1..1 | Ameliorating action taken after the adverse event occured in order to reduce the extent of harm Binding: AdverseEvent Mitigating Action (Example) | ||
| Reference(Procedure | DocumentReference | MedicationAdministration | MedicationRequest) | ||||
| CodeableConcept | ||||
| Σ | 0..* | BackboneElement | Supporting information relevant to the event | |
| Σ | 1..1 | Subject medical history or document relevant to this adverse event Binding: AdverseEvent Supporting Information (Example) | ||
| Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | DocumentReference | MedicationAdministration | MedicationStatement | QuestionnaireResponse) | ||||
| CodeableConcept | ||||
| Σ | 0..* | Annotation | Comment on adverse event | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External ids for this item | |
| ?!Σ | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntolerance Clinical Status Codes (Required) | |
| ?!Σ | 0..1 | CodeableConcept | unconfirmed | presumed | confirmed | refuted | entered-in-error Binding: AllergyIntolerance Verification Status (Required) | |
| ΣTU | 0..1 | CodeableConcept | allergy | intolerance - Underlying mechanism (if known) Binding: Allergy Intolerance Type (Preferred) | |
| Σ | 0..* | code | food | medication | environment | biologic Binding: Allergy Intolerance Category (Required) | |
| Σ | 0..1 | code | low | high | unable-to-assess Binding: Allergy Intolerance Criticality (Required) | |
| Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntolerance Substance/Product, Condition and Negation Codes (Example) | |
| Σ | 1..1 | Reference(Patient) | Who the allergy or intolerance is for | |
| 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | ||
| 0..1 | When allergy or intolerance was identified | |||
| dateTime | ||||
| Age | ||||
| Period | ||||
| Range | ||||
| string | ||||
| 0..1 | dateTime | Date allergy or intolerance was first recorded | ||
| Σ | 0..* | BackboneElement | Who or what participated in the activities related to the allergy or intolerance and how they were involved | |
| Σ | 0..1 | CodeableConcept | Type of involvement Binding: Participation Role Type (Extensible) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) | Who or what participated in the activities related to the allergy or intolerance | |
| 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | ||
| 0..* | Annotation | Additional text not captured in other fields | ||
| TU | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
| 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Substance Code (Example) | ||
| 1..* | CodeableReference(Observation) | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (Example) | ||
| 0..1 | string | Description of the event as a whole | ||
| 0..1 | dateTime | Date(/time) when manifestations showed | ||
| 0..1 | code | mild | moderate | severe (of event as a whole) Binding: Allergy Intolerance Severity (Required) | ||
| 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (Example) | ||
| 0..* | Annotation | Text about event not captured in other fields | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) + Rule: Either start and end are specified, or neither + Rule: Only proposed or cancelled appointments can be missing start/end dates + Rule: Cancellation reason is only used for appointments that have been cancelled, or noshow + Rule: The start must be less than or equal to the end + Guideline: An appointment may have an originatingAppointment or recurrenceTemplate, but not both + Rule: Cancellation date is only used for appointments that have been cancelled, or noshow Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this item | |
| ?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: Appointment Status (Required) | |
| ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason (Example) | |
| Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: EncounterClass (Preferred) | |
| Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: Service Category (Example) | |
| Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: Service Type (Example) | |
| Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Practice Setting Code Value Set (Preferred) | |
| Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (Preferred) | |
| Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: Encounter Reason Codes (Preferred) | |
| 0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (Example) | ||
| 0..1 | string | Shown on a subject line in a meeting request, or appointment list | ||
| 0..* | Reference(Appointment) | Appointment replaced by this Appointment | ||
| 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | ||
| 0..* | Reference(Any) | Additional information to support the appointment | ||
| 0..1 | Reference(Appointment) | The previous appointment in a series | ||
| C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments | |
| ΣC | 0..1 | instant | When appointment is to take place | |
| ΣC | 0..1 | instant | When appointment is to conclude | |
| 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | ||
| 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | ||
| 0..* | Reference(Slot) | The slots that this appointment is filling | ||
| 0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | ||
| 0..1 | dateTime | The date that this appointment was initially created | ||
| C | 0..1 | dateTime | When the appointment was cancelled | |
| 0..* | Annotation | Additional comments | ||
| 0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | ||
| 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | ||
| Σ | 0..1 | Reference(Patient | Group) | The patient or group associated with the appointment | |
| C | 1..* | BackboneElement | Participants involved in appointment + Rule: Either the type or actor on the participant SHALL be specified | |
| ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: Participant Type (Extensible) | |
| 0..1 | Period | Participation period of the actor | ||
| ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | The individual, device, location, or service participating in the appointment | |
| Σ | 0..1 | boolean | The participant is required to attend (optional when false) | |
| Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: Participation Status (Required) | |
| 0..1 | positiveInt | The sequence number in the recurrence | ||
| 0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | ||
| C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | |
| 0..1 | CodeableConcept | The timezone of the occurrences Binding: IANA Timezones (Required) | ||
| 1..1 | CodeableConcept | The frequency of the recurrence Binding: Appointment Recurrence Type (Preferred) | ||
| 0..1 | date | The date when the recurrence should end | ||
| 0..1 | positiveInt | The number of planned occurrences | ||
| 0..* | date | Specific dates for a recurring set of appointments (no template) | ||
| 0..1 | BackboneElement | Information about weekly recurring appointments | ||
| 0..1 | boolean | Recurs on Mondays | ||
| 0..1 | boolean | Recurs on Tuesday | ||
| 0..1 | boolean | Recurs on Wednesday | ||
| 0..1 | boolean | Recurs on Thursday | ||
| 0..1 | boolean | Recurs on Friday | ||
| 0..1 | boolean | Recurs on Saturday | ||
| 0..1 | boolean | Recurs on Sunday | ||
| 0..1 | positiveInt | Recurs every nth week | ||
| 0..1 | BackboneElement | Information about monthly recurring appointments | ||
| 0..1 | positiveInt | Recurs on a specific day of the month | ||
| 0..1 | Coding | Indicates which week of the month the appointment should occur Binding: Week Of Month (Required) | ||
| 0..1 | Coding | Indicates which day of the week the appointment should occur Binding: Days Of Week (Required) | ||
| 1..1 | positiveInt | Recurs every nth month | ||
| 0..1 | BackboneElement | Information about yearly recurring appointments | ||
| 1..1 | positiveInt | Recurs every nth year | ||
| 0..* | date | Any dates that should be excluded from the series | ||
| 0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection + Rule: Either the participantType or actor must be specified Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this item | |
| Σ | 1..1 | Reference(Appointment) | Appointment this response relates to | |
| Σ | 0..1 | boolean | Indicator for a counter proposal | |
| 0..1 | instant | Time from appointment, or requested new start time | ||
| 0..1 | instant | Time from appointment, or requested new end time | ||
| ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: Participant Type (Extensible) | |
| ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person(s), Location, HealthcareService, or Device | |
| ?!Σ | 1..1 | code | accepted | declined | tentative | needs-action | entered-in-error Binding: Appointment Response Status (Required) | |
| 0..1 | markdown | Additional comments | ||
| 0..1 | boolean | This response is for all occurrences in a recurring request | ||
| 0..1 | date | Original date within a recurring request | ||
| 0..1 | positiveInt | The recurrence ID of the specific recurring request | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Adds metadata-supported comments, classifiers or ratings related to a Resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Additional identifier for the artifact assessment | |
| ΣT | 0..1 | string | A short title for the assessment for use in displaying and selecting | |
| 0..1 | How to cite the comment or rating | |||
| Reference(Citation) | ||||
| markdown | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the artifact assessment was approved by publisher | ||
| Σ | 0..1 | date | When the artifact assessment was last reviewed by the publisher | |
| Σ | 1..1 | The artifact assessed, commented upon or rated | ||
| Reference(Any) | ||||
| canonical() | ||||
| uri | ||||
| 0..* | BackboneElement | Comment, classifier, or rating content | ||
| 0..1 | code | comment | classifier | rating | container | response | change-request Binding: Artifact Assessment Information Type (Required) | ||
| 0..1 | markdown | Brief summary of the content | ||
| 0..1 | CodeableConcept | What type of content Binding: Evidence Certainty Type (Example) | ||
| 0..* | CodeableConcept | Rating, classifier, or assessment Binding: Evidence Certainty Rating (Example) | ||
| 0..1 | Quantity | Quantitative rating | ||
| 0..1 | Reference(Patient | Practitioner | PractitionerRole | Organization | Device) | Who authored the content | ||
| 0..* | uri | What the comment is directed to | ||
| 0..* | RelatedArtifact | Additional information | ||
| 0..1 | boolean | Acceptable to publicly share the resource content | ||
| 0..* | see content | Contained content | ||
| Σ | 0..1 | code | submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error Binding: Artifact Assessment Workflow Status (Required) | |
| Σ | 0..1 | code | unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification Binding: Artifact Assessment Disposition (Required) | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Record of an event Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | CodeableConcept | Type/identifier of event Binding: Audit Event ID (Example) | |
| Σ | 1..1 | CodeableConcept | Specific type of event Binding: Audit Event Sub-Type (Example) | |
| Σ | 0..1 | code | Type of action performed during the event Binding: Audit Event Action (Required) | |
| Σ | 0..1 | code | emergency | alert | critical | error | warning | notice | informational | debug Binding: Audit Event Severity (Required) | |
| 0..1 | When the activity occurred | |||
| Period | ||||
| dateTime | ||||
| Σ | 1..1 | instant | Time when the event was recorded | |
| Σ | 0..1 | BackboneElement | Whether the event succeeded or failed | |
| Σ | 1..1 | Coding | Whether the event succeeded or failed Binding: Audit Event Outcome (Preferred) | |
| Σ | 0..* | CodeableConcept | Additional outcome detail Binding: Audit Event Outcome Detail (Example) | |
| Σ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (Example) | |
| 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | ||
| TU | 0..1 | Reference(Patient) | The patient is the subject of the data used/created/updated/deleted during the activity | |
| 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | ||
| Σ | 1..* | BackboneElement | Actor involved in the event | |
| 0..1 | CodeableConcept | How agent participated Binding: Participation Role Type (Preferred) | ||
| 0..* | CodeableConcept | Agent role in the event Binding: Security Role Type (Example) | ||
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | |
| Σ | 0..1 | boolean | Whether user is initiator | |
| 0..1 | Reference(Location) | The agent location when the event occurred | ||
| 0..* | uri | Policy that authorized the agent participation in the event | ||
| 0..1 | This agent network location for the activity | |||
| Reference(Endpoint) | ||||
| uri | ||||
| string | ||||
| 0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (Example) | ||
| Σ | 1..1 | BackboneElement | Audit Event Reporter | |
| 0..1 | Reference(Location) | Logical source location within the enterprise | ||
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event | |
| 0..* | CodeableConcept | The type of source where event originated Binding: Audit Event Source Type (Preferred) | ||
| Σ | 0..* | BackboneElement | Data or objects used | |
| Σ | 0..1 | Reference(Any) | Specific instance of resource | |
| 0..1 | CodeableConcept | What role the entity played Binding: Audit Event Entity Role (Example) | ||
| 0..* | CodeableConcept | Security labels on the entity Binding: Example set of Security Labels (Example) | ||
| Σ | 0..1 | base64Binary | Query parameters | |
| 0..* | BackboneElement | Additional Information about the entity | ||
| 1..1 | CodeableConcept | Name of the property Binding: Audit Event ID (Example) | ||
| 1..1 | Property value | |||
| Quantity | ||||
| CodeableConcept | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| Range | ||||
| Ratio | ||||
| time | ||||
| dateTime | ||||
| Period | ||||
| base64Binary | ||||
| 0..* | see agent | Entity is attributed to this agent | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Resource for non-supported content Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier | |
| ?!Σ | 1..1 | CodeableConcept | Kind of Resource Binding: Basic Resource Types (Example) | |
| Σ | 0..1 | Reference(Any) | Identifies the focus of this resource | |
| Σ | 0..1 | dateTime | When created | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization | Device | CareTeam) | Who created | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| N | Resource | Pure binary content defined by a format other than FHIR Elements defined in Ancestors: id, meta, implicitRules, language | ||
| Σ | 1..1 | code | MimeType of the binary content Binding: Mime Types (Required) | |
| Σ | 0..1 | Reference(Any) | Identifies another resource to use as proxy when enforcing access control | |
| 0..1 | base64Binary | The actual content | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | This resource reflects an instance of a biologically derived product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..1 | Coding | organ | tissue | fluid | cells | biologicalAgent Binding: Biologically Derived Product Category (Example) | ||
| 0..1 | CodeableConcept | A code that identifies the kind of this biologically derived product Binding: Biologically Derived Product Codes (Example) | ||
| 0..* | Reference(BiologicallyDerivedProduct) | The parent biologically-derived product | ||
| 0..* | Reference(ServiceRequest) | Request to obtain and/or infuse this product | ||
| Σ | 0..* | Identifier | Instance identifier | |
| Σ | 0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | |
| 0..* | Reference(Organization) | Processing facilities responsible for the labeling and distribution of this biologically derived product | ||
| 0..1 | string | A unique identifier for an aliquot of a product | ||
| 0..1 | Coding | available | unavailable Binding: Biologically Derived Product Status (Example) | ||
| 0..1 | dateTime | Date, and where relevant time, of expiration | ||
| 0..1 | BackboneElement | How this product was collected | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Individual performing collection | ||
| 0..1 | Reference(Patient | Organization) | The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection | ||
| 0..1 | Time of product collection | |||
| dateTime | ||||
| Period | ||||
| 0..1 | Range | Product storage temperature requirements | ||
| 0..* | BackboneElement | A property that is specific to this BiologicallyDerviedProduct instance | ||
| 1..1 | CodeableConcept | Code that specifies the property Binding: Biologically Derived Product Property Type Codes (Example) | ||
| 1..1 | Property values | |||
| boolean | ||||
| integer | ||||
| CodeableConcept | ||||
| Period | ||||
| Quantity | ||||
| Range | ||||
| Ratio | ||||
| string | ||||
| Attachment | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ΣD | DomainResource | A record of dispensation of a biologically derived product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for this dispense | |
| Σ | 0..* | Reference(ServiceRequest) | The order or request that this dispense is fulfilling | |
| Σ | 0..* | Reference(BiologicallyDerivedProductDispense) | Short description | |
| Σ | 1..1 | code | preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown Binding: BiologicallyDerivedProductDispense Status Codes (Required) | |
| Σ | 0..1 | CodeableConcept | Relationship between the donor and intended recipient Binding: Biologically derived product dispense - origin relationship (Example) | |
| Σ | 1..1 | Reference(BiologicallyDerivedProduct) | The BiologicallyDerivedProduct that is dispensed | |
| Σ | 1..1 | Reference(Patient) | The intended recipient of the dispensed product | |
| Σ | 0..1 | CodeableConcept | Indicates the type of matching associated with the dispense Binding: Biologically derived product dispense - match status (Example) | |
| Σ | 0..* | BackboneElement | Indicates who or what performed an action | |
| Σ | 0..1 | CodeableConcept | Identifies the function of the performer during the dispense Binding: Biologically derived product dispense - performer function (Example) | |
| Σ | 1..1 | Reference(Practitioner) | Who performed the action | |
| Σ | 0..1 | Reference(Location) | Where the dispense occurred | |
| Σ | 0..1 | SimpleQuantity | Amount dispensed | |
| Σ | 0..1 | dateTime | When product was selected/matched | |
| Σ | 0..1 | dateTime | When the product was dispatched | |
| Σ | 0..1 | Reference(Location) | Where the product was dispatched to | |
| Σ | 0..* | Annotation | Additional notes | |
| Σ | 0..1 | string | Specific instructions for use | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Specific and identified anatomical structure Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Bodystructure identifier | |
| ?!Σ | 0..1 | boolean | Whether this record is in active use | |
| Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMED CT Morphologic Abnormalities (Example) | |
| 1..* | BackboneElement | Included anatomic location(s) | ||
| Σ | 1..1 | CodeableConcept | Code that represents the included structure Binding: SNOMED CT Body Structures (Example) | |
| 0..1 | CodeableConcept | Code that represents the included structure laterality Binding: Bodystructure Location Qualifier (Example) | ||
| 0..* | BackboneElement | Landmark relative location | ||
| 0..* | CodeableConcept | Body ]andmark description Binding: SNOMED CT Body Structures (Example) | ||
| 0..* | CodeableConcept | Clockface orientation Binding: Bodystructure Body Landmark Clock Face Position (Example) | ||
| 0..* | BackboneElement | Landmark relative location | ||
| 0..* | CodeableReference(Device) | Measurement device Binding: Device Type (Example) | ||
| 0..* | Quantity | Measured distance from body landmark | ||
| 0..* | CodeableConcept | Relative landmark surface orientation Binding: Bodystructure Location Qualifier (Preferred) | ||
| 0..* | Reference(ImagingSelection) | Cartesian reference for structure | ||
| 0..* | CodeableConcept | Code that represents the included structure qualifier Binding: Bodystructure Location Qualifier (Example) | ||
| 0..* | see includedStructure | Excluded anatomic locations(s) | ||
| Σ | 0..1 | markdown | Text description | |
| 0..* | Attachment | Attached images | ||
| Σ | 1..1 | Reference(Patient) | Who this is about | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| N | Resource | Contains a collection of resources + Rule: total only when a search or history + Rule: entry.search only when a search + Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) + Rule: A document must have an identifier with a system and a value + Rule: A document must have a date + Rule: A document must have a Composition as the first resource + Rule: A message must have a MessageHeader as the first resource + Rule: A subscription-notification must have a SubscriptionStatus as the first resource + Rule: entry.request.method PATCH not allowed for history + Rule: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated + Rule: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. + Rule: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. + Rule: Self link is required for searchsets. + Rule: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements + Rule: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH + Rule: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH + Rule: For collections of type transaction-response or batch-response, all entries must contain response elements Elements defined in Ancestors: id, meta, implicitRules, language | ||
| ΣC | 0..1 | Identifier | Persistent identifier for the bundle | |
| ΣC | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: Bundle Type (Required) | |
| ΣC | 0..1 | instant | When the bundle was assembled | |
| ΣC | 0..1 | unsignedInt | If search, the total number of matches | |
| ΣC | 0..* | BackboneElement | Links related to this Bundle | |
| ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: Link Relation Types (Required) | |
| ΣC | 1..1 | uri | Reference details for the link | |
| ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information + Rule: must be a resource unless there's a request or response + Rule: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | |
| Σ | 0..* | see link | Links related to this entry | |
| ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| ΣC | 0..1 | Resource | A resource in the bundle | |
| ΣC | 0..1 | BackboneElement | Search related information | |
| Σ | 0..1 | code | match | include - why this is in the result set Binding: Search Entry Mode (Required) | |
| Σ | 0..1 | decimal | Search ranking (between 0 and 1) | |
| ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: H T T P Verb (Required) | |
| Σ | 1..1 | uri | URL for HTTP equivalent of this entry | |
| Σ | 0..1 | string | For managing cache validation | |
| Σ | 0..1 | instant | For managing cache currency | |
| Σ | 0..1 | string | For managing update contention | |
| Σ | 0..1 | string | For conditional creates | |
| ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | |
| Σ | 1..1 | string | Status response code (text optional) | |
| Σ | 0..1 | uri | The location (if the operation returns a location) | |
| Σ | 0..1 | string | The Etag for the resource (if relevant) | |
| Σ | 0..1 | instant | Server's date time modified | |
| Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |
| ΣTU | 0..1 | Signature | Digital Signature | |
| ΣCTU | 0..1 | Resource | Issues with the Bundle | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| «I»N | DomainResource | Common Interface declaration for definitional resources + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestor Resources: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| ΣC | 0..1 | uri | Canonical identifier for this {{title}}, represented as an absolute URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the {{title}} | |
| Σ | 0..1 | string | Business version of the {{title}} | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this {{title}} (computer friendly) | |
| Σ | 0..1 | string | Name for this {{title}} (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the {{title}} | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for {{title}} (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| 0..1 | markdown | Why this {{title}} is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| T | 0..1 | string | Copyright holder and year(s) | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| N | DomainResource | A statement of system capabilities + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: A Capability Statement SHALL have at least one of REST, messaging or document element. + Rule: A Capability Statement SHALL have at least one of description, software, or implementation element. + Rule: Messaging end-point is only permitted when a capability statement is for an implementation. + Rule: There should only be one CapabilityStatement.rest per mode. + Rule: The set of documents must be unique by the combination of profile and mode. + Rule: If kind = instance, implementation must be present and software may be present + Rule: If kind = capability, implementation must be absent, software must be present + Rule: If kind = requirements, implementation and software must be absent Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||||||
| ΣC | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |||||
| ΣTU | 0..* | Identifier | Additional identifier for the CapabilityStatement (business identifier) | |||||
| Σ | 0..1 | string | Business version of the capability statement | |||||
| ΣTU | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| ΣC | 0..1 | string | Name for this capability statement (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this capability statement (human friendly) | |||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
| Σ | 1..1 | dateTime | Date last changed | |||||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| TC | 0..1 | markdown | Natural language description of the capability statement | |||||
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| T | 0..1 | markdown | Why this capability statement is defined | |||||
| T | 0..1 | markdown | Use and/or publishing restrictions | |||||
| TTU | 0..1 | string | Copyright holder and year(s) | |||||
| ΣC | 1..1 | code | instance | capability | requirements Binding: Capability Statement Kind (Required) | |||||
| Σ | 0..* | canonical(CapabilityStatement) | Canonical URL of another capability statement this implements | |||||
| ΣTU | 0..* | canonical(CapabilityStatement) | Canonical URL of another capability statement this adds to | |||||
| ΣC | 0..1 | BackboneElement | Software that is covered by this capability statement | |||||
| Σ | 1..1 | string | A name the software is known by | |||||
| Σ | 0..1 | string | Version covered by this statement | |||||
| Σ | 0..1 | dateTime | Date this version was released | |||||
| ΣC | 0..1 | BackboneElement | If this describes a specific instance | |||||
| Σ | 1..1 | markdown | Describes this specific instance | |||||
| Σ | 0..1 | url | Base URL for the installation | |||||
| ΣTU | 0..1 | Reference(Organization) | Organization that manages the data | |||||
| Σ | 1..1 | code | FHIR Version the system supports Binding: FHIRVersion (Required) | |||||
| Σ | 1..* | code | formats supported (xml | json | ttl | mime type) Binding: Mime Types (Required)
| |||||
| Σ | 0..* | code | Patch formats supported Binding: Mime Types (Required) | |||||
| ΣTU | 0..* | code | Languages supported Binding: All Languages (Required)
| |||||
| Σ | 0..* | canonical(ImplementationGuide) | Implementation guides supported | |||||
| ΣC | 0..* | BackboneElement | If the endpoint is a RESTful one + Rule: A given resource can only be described once per RESTful mode. | |||||
| ΣC | 1..1 | code | client | server Binding: Restful Capability Mode (Required) | |||||
| T | 0..1 | markdown | General description of implementation | |||||
| ΣTU | 0..1 | BackboneElement | Information about security of implementation | |||||
| Σ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) | |||||
| Σ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates Binding: Restful Security Service (Extensible) | |||||
| T | 0..1 | markdown | General description of how security works | |||||
| ΣC | 0..* | BackboneElement | Resource served on the REST interface + Rule: Search parameter names must be unique in the context of a resource. | |||||
| ΣC | 1..1 | code | A resource type that is supported Binding: Resource Types (Required) | |||||
| Σ | 0..1 | canonical(StructureDefinition) | System-wide profile | |||||
| ΣTU | 0..* | canonical(StructureDefinition) | Use-case specific profiles | |||||
| T | 0..1 | markdown | Additional information about the use of the resource type | |||||
| 0..* | BackboneElement | What operations are supported? | ||||||
| 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type Binding: Type Restful Interaction (Required) | ||||||
| T | 0..1 | markdown | Anything special about operation behavior | |||||
| TU | 0..1 | code | no-version | versioned | versioned-update Binding: Resource Version Policy (Required) | |||||
| TU | 0..1 | boolean | Whether vRead can return past versions | |||||
| TU | 0..1 | boolean | If update can commit to a new identity | |||||
| TU | 0..1 | boolean | If allows/uses conditional create | |||||
| TU | 0..1 | code | not-supported | modified-since | not-match | full-support Binding: Conditional Read Status (Required) | |||||
| TU | 0..1 | boolean | If allows/uses conditional update | |||||
| TU | 0..1 | boolean | If allows/uses conditional patch | |||||
| TU | 0..1 | code | not-supported | single | multiple - how conditional delete is supported Binding: Conditional Delete Status (Required) | |||||
| TU | 0..* | code | literal | logical | resolves | enforced | local Binding: Reference Handling Policy (Required) | |||||
| TU | 0..* | string | _include values supported by the server | |||||
| TU | 0..* | string | _revinclude values supported by the server | |||||
| C | 0..* | BackboneElement | Search parameters supported by implementation | |||||
| C | 1..1 | string | Name for parameter in search url | |||||
| 0..1 | canonical(SearchParameter) | Source of definition for parameter | ||||||
| 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (Required) | ||||||
| 0..1 | markdown | Server-specific usage | ||||||
| Σ | 0..* | BackboneElement | Definition of a resource operation | |||||
| Σ | 1..1 | string | Name by which the operation/query is invoked | |||||
| Σ | 1..1 | canonical(OperationDefinition) | The defined operation/query | |||||
| T | 0..1 | markdown | Specific details about operation behavior | |||||
| 0..* | BackboneElement | What operations are supported? | ||||||
| 1..1 | code | transaction | batch | search-system | history-system Binding: System Restful Interaction (Required) | ||||||
| T | 0..1 | markdown | Anything special about operation behavior | |||||
| 0..* | see searchParam | Search parameters for searching all resources | ||||||
| Σ | 0..* | see operation | Definition of a system level operation | |||||
| 0..* | canonical(CompartmentDefinition) | Compartments served/used by system | ||||||
| ΣCTU | 0..* | BackboneElement | If messaging is supported | |||||
| C | 0..* | BackboneElement | Where messages should be sent | |||||
| 1..1 | Coding | http | ftp | mllp + Binding: Message Transport (Extensible) | ||||||
| 1..1 | url | Network address or identifier of the end-point | ||||||
| 0..1 | unsignedInt | Reliable Message Cache Length (min) | ||||||
| T | 0..1 | markdown | Messaging interface behavior details | |||||
| Σ | 0..* | BackboneElement | Messages supported by this system | |||||
| Σ | 1..1 | code | sender | receiver Binding: Event Capability Mode (Required) | |||||
| Σ | 1..1 | canonical(MessageDefinition) | Message supported by this system | |||||
| ΣCTU | 0..* | BackboneElement | Document definition | |||||
| ΣC | 1..1 | code | producer | consumer Binding: Document Mode (Required) | |||||
| T | 0..1 | markdown | Description of document support | |||||
| ΣC | 1..1 | canonical(StructureDefinition) | Constraint on the resources used in the document | |||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Healthcare plan for patient or group Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this plan | |
| Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| Σ | 0..* | Reference(CarePlan | ServiceRequest | RequestOrchestration | NutritionOrder) | Fulfills plan, proposal or order | |
| Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | |
| Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | |
| ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (Required) | |
| ?!Σ | 1..1 | code | proposal | plan | order | option | directive Binding: Care Plan Intent (Required) | |
| Σ | 0..* | CodeableConcept | Type of plan Binding: Care Plan Category (Example) | |
| Σ | 0..1 | string | Human-friendly name for the care plan | |
| Σ | 0..1 | string | Summary of nature of plan | |
| Σ | 1..1 | Reference(Patient | Group) | Who the care plan is for | |
| Σ | 0..1 | Reference(Encounter) | The Encounter during which this CarePlan was created | |
| Σ | 0..1 | Period | Time period plan covers | |
| Σ | 0..1 | dateTime | Date record was first recorded | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | |
| 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | ||
| 0..* | Reference(CareTeam) | Who's involved in plan? | ||
| Σ | 0..* | CodeableReference(Condition) | Health issues this plan addresses Binding: SNOMED CT Clinical Findings (Example) | |
| 0..* | Reference(Any) | Information considered as part of plan | ||
| 0..* | Reference(Goal) | Desired outcome of plan | ||
| 0..* | BackboneElement | Action to occur or has occurred as part of plan | ||
| 0..* | CodeableReference(Any) | Results of the activity (concept, or Appointment, Encounter, Procedure, etc.) Binding: Care Plan Activity Performed (Example) | ||
| 0..* | Annotation | Comments about the activity status/progress | ||
| 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestOrchestration | ImmunizationRecommendation | SupplyRequest) | Activity that is intended to be part of the care plan | ||
| 0..* | Annotation | Comments about the plan | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Planned participants in the coordination and delivery of care Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this team | |
| ?!Σ | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: Care Team Status (Required) | |
| Σ | 0..* | CodeableConcept | Type of team Binding: Care Team category (Example) | |
| Σ | 0..1 | string | Name of the team, such as crisis assessment team | |
| Σ | 0..1 | Reference(Patient | Group) | Who care team is for | |
| Σ | 0..1 | Period | Time period team covers | |
| C | 0..* | BackboneElement | Members of the team + Rule: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner + Warning: CareTeam.participant.role or CareTeam.participant.member exists | |
| ΣC | 0..1 | CodeableConcept | Type of involvement Binding: Participant Roles (Example) | |
| ΣC | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | |
| ΣC | 0..1 | Reference(Organization) | Organization of the practitioner | |
| 0..1 | When the member is generally available within this care team | |||
| Period | ||||
| Timing | ||||
| 0..* | CodeableReference(Condition) | Why the care team exists Binding: SNOMED CT Clinical Findings (Example) | ||
| Σ | 0..* | Reference(Organization) | Organization responsible for the care team | |
| 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | ||
| 0..* | Annotation | Comments made about the CareTeam | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Item containing charge code(s) associated with the provision of healthcare provider products Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business Identifier for item | |
| 0..* | uri | Defining information about the code of this charge item | ||
| 0..* | canonical(ChargeItemDefinition) | Resource defining the code of this ChargeItem | ||
| ?!Σ | 1..1 | code | planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: Charge Item Status (Required) | |
| 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | ||
| Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code Binding: Charge Item Code (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Individual service was done for/to | |
| Σ | 0..1 | Reference(Encounter) | Encounter associated with this ChargeItem | |
| Σ | 0..1 | When the charged service was applied | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| 0..* | BackboneElement | Who performed charged service | ||
| 0..1 | CodeableConcept | What type of performance was done Binding: Procedure Performer Role Codes (Example) | ||
| 1..1 | Reference(Practitioner | PractitionerRole | Organization | HealthcareService | CareTeam | Patient | Device | RelatedPerson) | Individual who was performing | ||
| 0..1 | Reference(Organization) | Organization providing the charged service | ||
| 0..1 | Reference(Organization) | Organization requesting the charged service | ||
| 0..1 | Reference(Organization) | Organization that has ownership of the (potential, future) revenue | ||
| Σ | 0..1 | Quantity | Quantity of which the charge item has been serviced | |
| Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMED CT Body Structures (Example) | |
| 0..1 | MonetaryComponent | Unit price overriding the associated rules | ||
| 0..1 | MonetaryComponent | Total price overriding the associated rules | ||
| 0..1 | CodeableConcept | Reason for overriding the list price/factor Binding: override-reason (Example) | ||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was entering | |
| Σ | 0..1 | dateTime | Date the charge item was entered | |
| 0..* | CodeableConcept | Why was the charged service rendered? Binding: ICD-10 Codes (Example) | ||
| 0..* | CodeableReference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationRequest | Observation | Procedure | ServiceRequest | SupplyDelivery) | Which rendered service is being charged? | ||
| 0..* | CodeableReference(Device | Medication | Substance) | Product charged Binding: Device Type (Example) | ||
| Σ | 0..* | Reference(Account) | Account to place this charge | |
| 0..* | Annotation | Comments made about the ChargeItem | ||
| 0..* | Reference(Any) | Further information supporting this charge | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this charge item definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the charge item definition | |
| Σ | 0..1 | string | Business version of the charge item definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this charge item definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this charge item definition (human friendly) | |
| Σ | 0..* | uri | Underlying externally-defined charge item definition | |
| Σ | 0..* | canonical(ChargeItemDefinition) | A larger definition of which this particular definition is a component or step | |
| Σ | 0..* | canonical(ChargeItemDefinition) | Completed or terminated request(s) whose function is taken by this new request | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the charge item definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for charge item definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this charge item definition is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the charge item definition was approved by publisher | ||
| 0..1 | date | When the charge item definition was last reviewed by the publisher | ||
| Σ | 0..1 | CodeableConcept | Billing code or product type this definition applies to Binding: Charge Item Code (Example) | |
| 0..* | Reference(Medication | Substance | Device | DeviceDefinition | ActivityDefinition | PlanDefinition | HealthcareService) | Instances this definition applies to | ||
| 0..* | BackboneElement | Whether or not the billing code is applicable | ||
| 0..1 | Expression | Boolean-valued expression | ||
| Σ | 0..1 | Period | When the charge item definition is expected to be used | |
| 0..1 | RelatedArtifact | Reference to / quotation of the external source of the group of properties | ||
| 0..* | BackboneElement | Group of properties which are applicable under the same conditions | ||
| 0..* | see applicability | Conditions under which the priceComponent is applicable | ||
| 0..* | MonetaryComponent | Components of total line item price | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A description of identification, location, or contributorship of a publication (article or artifact) + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this citation record, represented as a globally unique URI + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Identifier for the citation record itself | |
| Σ | 0..1 | string | Business version of the citation record | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this citation record (computer friendly) | |
| ΣT | 0..1 | string | Name for this citation record (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | The publisher of the citation record, not the publisher of the article or artifact being cited | |
| Σ | 0..* | ContactDetail | Contact details for the publisher of the citation record | |
| T | 0..1 | markdown | Natural language description of the citation | |
| Σ | 0..* | UsageContext | The context that the citation record content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for citation record (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this citation is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions for the citation record, not for the cited artifact | |
| T | 0..1 | string | Copyright holder and year(s) for the ciation record, not for the cited artifact | |
| 0..1 | date | When the citation record was approved by publisher | ||
| 0..1 | date | When the citation record was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the citation record is expected to be used | |
| 0..* | ContactDetail | Who authored the citation record | ||
| 0..* | ContactDetail | Who edited the citation record | ||
| 0..* | ContactDetail | Who reviewed the citation record | ||
| 0..* | ContactDetail | Who endorsed the citation record | ||
| 0..* | BackboneElement | A human-readable display of key concepts to represent the citation | ||
| 0..1 | CodeableConcept | Format for display of the citation summary Binding: Citation Summary Style (Extensible) | ||
| Σ | 1..1 | markdown | The human-readable display of the citation summary | |
| 0..* | BackboneElement | The assignment to an organizing scheme | ||
| 0..1 | CodeableConcept | The kind of classifier (e.g. publication type, keyword) Binding: Citation Classification Type (Extensible) | ||
| 0..* | CodeableConcept | The specific classification value Binding: Citation Artifact Classifier (Example) | ||
| 0..* | Annotation | Used for general notes and annotations not coded elsewhere | ||
| 0..* | CodeableConcept | The status of the citation record Binding: Citation Status Type (Example) | ||
| 0..* | BackboneElement | An effective date or period for a status of the citation record | ||
| 1..1 | CodeableConcept | Classification of the status Binding: Citation Status Type (Example) | ||
| 0..1 | boolean | Either occurred or expected | ||
| 1..1 | Period | When the status started and/or ended | ||
| 0..* | RelatedArtifact | Artifact related to the citation record | ||
| 0..1 | BackboneElement | The article or artifact being described | ||
| Σ | 0..* | Identifier | Unique identifier. May include DOI, PMID, PMCID, etc | |
| Σ | 0..* | Identifier | Identifier not unique to the cited artifact. May include trial registry identifiers | |
| Σ | 0..1 | dateTime | When the cited artifact was accessed | |
| 0..1 | BackboneElement | The defined version of the cited artifact | ||
| 1..1 | string | The version number or other version identifier | ||
| 0..1 | Reference(Citation) | Citation for the main version of the cited artifact | ||
| 0..* | CodeableConcept | The status of the cited artifact Binding: Cited Artifact Status Type (Extensible) | ||
| 0..* | BackboneElement | An effective date or period for a status of the cited artifact | ||
| 1..1 | CodeableConcept | Classification of the status Binding: Cited Artifact Status Type (Extensible) | ||
| 0..1 | boolean | Either occurred or expected | ||
| 1..1 | Period | When the status started and/or ended | ||
| 0..* | BackboneElement | The title details of the article or artifact | ||
| 0..* | CodeableConcept | The kind of title Binding: Title Type (Extensible) | ||
| 0..1 | CodeableConcept | Used to express the specific language Binding: Common Languages (Preferred) | ||
| 1..1 | markdown | The title of the article or artifact | ||
| 0..* | BackboneElement | Summary of the article or artifact | ||
| 0..1 | CodeableConcept | The kind of abstract Binding: Cited Artifact Abstract Type (Extensible) | ||
| 0..1 | CodeableConcept | Used to express the specific language Binding: Common Languages (Preferred) | ||
| 1..1 | markdown | Abstract content | ||
| 0..1 | markdown | Copyright notice for the abstract | ||
| 0..1 | BackboneElement | The component of the article or artifact | ||
| 0..1 | CodeableConcept | The kind of component Binding: Cited Artifact Part Type (Extensible) | ||
| 0..1 | string | The specification of the component | ||
| 0..1 | Reference(Citation) | The citation for the full article or artifact | ||
| 0..* | BackboneElement | The artifact related to the cited artifact | ||
| 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of Binding: Related Artifact Type All (Required) | ||
| 0..* | CodeableConcept | Additional classifiers Binding: Citation Artifact Classifier (Extensible) | ||
| 0..1 | string | Short label | ||
| 0..1 | string | Brief description of the related artifact | ||
| 0..1 | markdown | Bibliographic citation for the artifact | ||
| 0..1 | Attachment | What document is being referenced | ||
| 0..1 | canonical() | What artifact is being referenced | ||
| 0..1 | Reference() | What artifact, if not a conformance resource | ||
| 0..* | BackboneElement | If multiple, used to represent alternative forms of the article that are not separate citations | ||
| 0..1 | BackboneElement | The collection the cited article or artifact is published in | ||
| 0..1 | CodeableConcept | Kind of container (e.g. Periodical, database, or book) Binding: Published In Type (Extensible) | ||
| 0..* | Identifier | Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN | ||
| 0..1 | string | Name of the database or title of the book or journal | ||
| 0..1 | Reference(Organization) | Name of or resource describing the publisher | ||
| 0..1 | string | Geographic location of the publisher | ||
| 0..1 | CodeableConcept | Internet or Print Binding: Cited Medium (Extensible) | ||
| 0..1 | string | Volume number of journal or other collection in which the article is published | ||
| 0..1 | string | Issue, part or supplement of journal or other collection in which the article is published | ||
| 0..1 | dateTime | The date the article was added to the database, or the date the article was released | ||
| 0..1 | string | Text representation of the date on which the issue of the cited artifact was published | ||
| 0..1 | string | Season in which the cited artifact was published | ||
| 0..1 | dateTime | The date the article was last revised or updated in the database | ||
| 0..* | CodeableConcept | Language(s) in which this form of the article is published Binding: Common Languages (Preferred) | ||
| 0..1 | string | Entry number or identifier for inclusion in a database | ||
| 0..1 | string | Used for full display of pagination | ||
| 0..1 | string | Used for isolated representation of first page | ||
| 0..1 | string | Used for isolated representation of last page | ||
| 0..1 | string | Number of pages or screens | ||
| 0..1 | markdown | Copyright notice for the full article or artifact | ||
| 0..* | BackboneElement | Used for any URL for the article or artifact cited | ||
| 0..* | CodeableConcept | Code the reason for different URLs, e.g. abstract and full-text Binding: Artifact Url Classifier (Extensible) | ||
| 0..1 | uri | The specific URL | ||
| 0..* | BackboneElement | The assignment to an organizing scheme | ||
| 0..1 | CodeableConcept | The kind of classifier (e.g. publication type, keyword) Binding: Cited Artifact Classification Type (Extensible) | ||
| 0..* | CodeableConcept | The specific classification value Binding: Citation Artifact Classifier (Example) | ||
| 0..* | Reference(ArtifactAssessment) | Complex or externally created classification | ||
| 0..1 | BackboneElement | Attribution of authors and other contributors | ||
| 0..1 | boolean | Indicates if the list includes all authors and/or contributors | ||
| 0..* | BackboneElement | An individual entity named as a contributor | ||
| 1..1 | Reference(Practitioner | Organization) | The identity of the individual contributor | ||
| 0..1 | string | For citation styles that use initials | ||
| 0..* | Reference(Organization | PractitionerRole) | Organizational affiliation | ||
| 0..* | CodeableConcept | The specific contribution Binding: Artifact Contribution Type (Extensible) | ||
| 0..1 | CodeableConcept | The role of the contributor (e.g. author, editor, reviewer, funder) Binding: Contributor Role (Extensible) | ||
| 0..* | BackboneElement | Contributions with accounting for time or number | ||
| 1..1 | CodeableConcept | The specific contribution Binding: Artifact Contribution Instance Type (Extensible) | ||
| 0..1 | dateTime | The time that the contribution was made | ||
| 0..1 | boolean | Whether the contributor is the corresponding contributor for the role | ||
| 0..1 | positiveInt | Ranked order of contribution | ||
| 0..* | BackboneElement | Used to record a display of the author/contributor list without separate data element for each list member | ||
| 0..1 | CodeableConcept | Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement Binding: Contributor Summary Type (Extensible) | ||
| 0..1 | CodeableConcept | The format for the display string Binding: Contributor Summary Style (Extensible) | ||
| 0..1 | CodeableConcept | Used to code the producer or rule for creating the display string Binding: Contributor Summary Source (Extensible) | ||
| 1..1 | markdown | The display string for the author list, contributor list, or contributorship statement | ||
| 0..* | Annotation | Any additional information or content for the article or artifact | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Claim, Pre-determination or Pre-authorization Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier for claim | ||
| 0..* | Identifier | Number for tracking | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| Σ | 1..1 | CodeableConcept | Category or discipline Binding: Claim Type Codes (Extensible) | |
| 0..1 | CodeableConcept | More granular claim type Binding: Example Claim SubType Codes (Example) | ||
| Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (Required) | |
| Σ | 1..1 | Reference(Patient) | The recipient of the products and services | |
| Σ | 0..1 | Period | Relevant time frame for the claim | |
| Σ | 1..1 | dateTime | Resource creation date | |
| 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Author of the claim | ||
| Σ | 0..1 | Reference(Organization) | Target | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim | |
| Σ | 0..1 | CodeableConcept | Desired processing urgency Binding: Process Priority Codes (Example) | |
| 0..1 | CodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (Example) | ||
| 0..* | BackboneElement | Prior or corollary claims | ||
| 0..1 | Reference(Claim) | Reference to the related claim | ||
| 0..1 | CodeableConcept | How the reference claim is related Binding: Example Related Claim Relationship Codes (Example) | ||
| 0..1 | Identifier | File or case reference | ||
| 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Prescription authorizing services and products | ||
| 0..1 | Reference(DeviceRequest | MedicationRequest | VisionPrescription) | Original prescription if superseded by fulfiller | ||
| 0..1 | BackboneElement | Recipient of benefits payable | ||
| 1..1 | CodeableConcept | Category of recipient Binding: Claim Payee Type Codes (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | ||
| 0..1 | Reference(ServiceRequest) | Treatment referral | ||
| 0..* | Reference(Encounter) | Encounters associated with the listed treatments | ||
| 0..1 | Reference(Location | Organization) | Servicing facility | ||
| 0..1 | CodeableConcept | Package billing code Binding: Example Diagnosis Related Group Codes (Example) | ||
| 0..* | BackboneElement | Event information | ||
| 1..1 | CodeableConcept | Specific event Binding: Dates Type Codes (Example) | ||
| 1..1 | Occurance date or period | |||
| dateTime | ||||
| Period | ||||
| 0..* | BackboneElement | Members of the care team | ||
| 1..1 | positiveInt | Order of care team | ||
| 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Practitioner or organization | ||
| 0..1 | boolean | Indicator of the lead practitioner | ||
| 0..1 | CodeableConcept | Function within the team Binding: Claim Care Team Role Codes (Example) | ||
| 0..1 | CodeableConcept | Practitioner or provider specialization Binding: Example Provider Qualification Codes (Example) | ||
| 0..* | BackboneElement | Supporting information | ||
| 1..1 | positiveInt | Information instance identifier | ||
| 1..1 | CodeableConcept | Classification of the supplied information Binding: Claim Information Category Codes (Example) | ||
| 0..1 | CodeableConcept | Type of information Binding: Exception Codes (Example) | ||
| 0..1 | When it occurred | |||
| date | ||||
| Period | ||||
| 0..1 | Data to be provided | |||
| boolean | ||||
| string | ||||
| Quantity | ||||
| Attachment | ||||
| Reference(Any) | ||||
| Identifier | ||||
| 0..1 | CodeableConcept | Explanation for the information Binding: Missing Tooth Reason Codes (Example) | ||
| 0..* | BackboneElement | Pertinent diagnosis information | ||
| 1..1 | positiveInt | Diagnosis instance identifier | ||
| 1..1 | Nature of illness or problem Binding: ICD-10 Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Condition) | ||||
| 0..* | CodeableConcept | Timing or nature of the diagnosis Binding: Example Diagnosis Type Codes (Example) | ||
| 0..1 | CodeableConcept | Present on admission Binding: Example Diagnosis on Admission Codes (Example) | ||
| 0..* | BackboneElement | Clinical procedures performed | ||
| 1..1 | positiveInt | Procedure instance identifier | ||
| 0..* | CodeableConcept | Category of Procedure Binding: Example Procedure Type Codes (Example) | ||
| 0..1 | dateTime | When the procedure was performed | ||
| 1..1 | Specific clinical procedure Binding: ICD-10 Procedure Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Procedure) | ||||
| 0..* | Reference(Device) | Unique device identifier | ||
| Σ | 0..* | BackboneElement | Patient insurance information | |
| Σ | 1..1 | positiveInt | Insurance instance identifier | |
| Σ | 1..1 | boolean | Coverage to be used for adjudication | |
| 0..1 | Identifier | Pre-assigned Claim number | ||
| Σ | 1..1 | Reference(Coverage) | Insurance information | |
| 0..1 | string | Additional provider contract number | ||
| 0..* | string | Prior authorization reference number | ||
| 0..1 | Reference(ClaimResponse) | Adjudication results | ||
| 0..1 | BackboneElement | Details of the event | ||
| 1..1 | date | When the incident occurred | ||
| 0..1 | CodeableConcept | The nature of the accident Binding: ActIncidentCode (Extensible) | ||
| 0..1 | Where the event occurred | |||
| Address | ||||
| Reference(Location) | ||||
| 0..1 | Money | Paid by the patient | ||
| 0..* | BackboneElement | Product or service provided | ||
| 1..1 | positiveInt | Item instance identifier | ||
| 0..* | Identifier | Number for tracking | ||
| 0..* | positiveInt | Applicable careTeam members | ||
| 0..* | positiveInt | Applicable diagnoses | ||
| 0..* | positiveInt | Applicable procedures | ||
| 0..* | positiveInt | Applicable exception and supporting information | ||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||
| 0..* | Reference(DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription) | Request or Referral for Service | ||
| 0..* | CodeableConcept | Product or service billing modifiers Binding: Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||
| 0..1 | Date or dates of service or product delivery | |||
| date | ||||
| Period | ||||
| 0..1 | Place of service or where product was supplied Binding: Example Service Place Codes (Example) | |||
| CodeableConcept | ||||
| Address | ||||
| Reference(Location) | ||||
| 0..1 | Money | Paid by the patient | ||
| 0..1 | SimpleQuantity | Count of products or services | ||
| 0..1 | Money | Fee, charge or cost per item | ||
| 0..1 | decimal | Price scaling factor | ||
| 0..1 | Money | Total tax | ||
| 0..1 | Money | Total item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..* | BackboneElement | Anatomical location | ||
| 1..* | CodeableReference(BodyStructure) | Location Binding: Oral Site Codes (Example) | ||
| 0..* | CodeableConcept | Sub-location Binding: Surface Codes (Example) | ||
| 0..* | Reference(Encounter) | Encounters associated with the listed treatments | ||
| 0..* | BackboneElement | Product or service provided | ||
| 1..1 | positiveInt | Item instance identifier | ||
| 0..* | Identifier | Number for tracking | ||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||
| 0..1 | Money | Paid by the patient | ||
| 0..1 | SimpleQuantity | Count of products or services | ||
| 0..1 | Money | Fee, charge or cost per item | ||
| 0..1 | decimal | Price scaling factor | ||
| 0..1 | Money | Total tax | ||
| 0..1 | Money | Total item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..* | BackboneElement | Product or service provided | ||
| 1..1 | positiveInt | Item instance identifier | ||
| 0..* | Identifier | Number for tracking | ||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||
| 0..1 | Money | Paid by the patient | ||
| 0..1 | SimpleQuantity | Count of products or services | ||
| 0..1 | Money | Fee, charge or cost per item | ||
| 0..1 | decimal | Price scaling factor | ||
| 0..1 | Money | Total tax | ||
| 0..1 | Money | Total item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..1 | Money | Total claim cost | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | Response to a claim predetermination or preauthorization Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| 0..* | Identifier | Business Identifier for a claim response | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |||||
| Σ | 1..1 | CodeableConcept | More granular claim type Binding: Claim Type Codes (Extensible) | |||||
| 0..1 | CodeableConcept | More granular claim type Binding: Example Claim SubType Codes (Example) | ||||||
| Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (Required) | |||||
| Σ | 1..1 | Reference(Patient) | The recipient of the products and services | |||||
| Σ | 1..1 | dateTime | Response creation date | |||||
| Σ | 0..1 | Reference(Organization) | Party responsible for reimbursement | |||||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim | ||||||
| Σ | 0..1 | Reference(Claim) | Id of resource triggering adjudication | |||||
| Σ | 1..1 | code | queued | complete | error | partial Binding: Claim Processing Codes (Required) | |||||
| Σ | 0..1 | CodeableConcept | Result of the adjudication Binding: Claim Adjudication Decision Codes (Example) | |||||
| 0..1 | string | Disposition Message | ||||||
| 0..1 | string | Preauthorization reference | ||||||
| 0..1 | Period | Preauthorization reference effective period | ||||||
| 0..* | BackboneElement | Event information | ||||||
| 1..1 | CodeableConcept | Specific event Binding: Dates Type Codes (Example) | ||||||
| 1..1 | Occurance date or period | |||||||
| dateTime | ||||||||
| Period | ||||||||
| 0..1 | CodeableConcept | Party to be paid any benefits payable Binding: Claim Payee Type Codes (Example) | ||||||
| 0..* | Reference(Encounter) | Encounters associated with the listed treatments | ||||||
| 0..1 | CodeableConcept | Package billing code Binding: Example Diagnosis Related Group Codes (Example) | ||||||
| 0..* | BackboneElement | Adjudication for claim line items | ||||||
| 1..1 | positiveInt | Claim item instance identifier | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | BackboneElement | Adjudication results | ||||||
| 0..1 | CodeableConcept | Result of the adjudication Binding: Claim Adjudication Decision Codes (Example) | ||||||
| 0..* | CodeableConcept | Reason for result of the adjudication Binding: Claim Adjudication Decision Reason Codes (Example) | ||||||
| 0..1 | string | Preauthorization reference | ||||||
| 0..1 | Period | Preauthorization reference effective period | ||||||
| 0..* | BackboneElement | Adjudication details | ||||||
| 1..1 | CodeableConcept | Type of adjudication information Binding: Adjudication Value Codes (Example) | ||||||
| 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: Adjudication Reason Codes (Example) | ||||||
| 0..1 | Money | Monetary amount | ||||||
| 0..1 | Quantity | Non-monetary value | ||||||
| 0..* | BackboneElement | Adjudication for claim details | ||||||
| 1..1 | positiveInt | Claim detail instance identifier | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Detail level adjudication results | ||||||
| 0..* | see adjudication | Detail level adjudication details | ||||||
| 0..* | BackboneElement | Adjudication for claim sub-details | ||||||
| 1..1 | positiveInt | Claim sub-detail instance identifier | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Subdetail level adjudication results | ||||||
| 0..* | see adjudication | Subdetail level adjudication details | ||||||
| 0..* | BackboneElement | Insurer added line items | ||||||
| 0..* | positiveInt | Item sequence number | ||||||
| 0..* | positiveInt | Detail sequence number | ||||||
| 0..* | positiveInt | Subdetail sequence number | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | Reference(DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription) | Request or Referral for Service | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||||||
| 0..1 | Date or dates of service or product delivery | |||||||
| date | ||||||||
| Period | ||||||||
| 0..1 | Place of service or where product was supplied Binding: Example Service Place Codes (Example) | |||||||
| CodeableConcept | ||||||||
| Address | ||||||||
| Reference(Location) | ||||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | BackboneElement | Anatomical location | ||||||
| 1..* | CodeableReference(BodyStructure) | Location Binding: Oral Site Codes (Example) | ||||||
| 0..* | CodeableConcept | Sub-location Binding: Surface Codes (Example) | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Added items adjudication results | ||||||
| 0..* | see adjudication | Added items adjudication | ||||||
| 0..* | BackboneElement | Insurer added line details | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Added items detail level adjudication results | ||||||
| 0..* | see adjudication | Added items detail adjudication | ||||||
| 0..* | BackboneElement | Insurer added line items | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Added items subdetail level adjudication results | ||||||
| 0..* | see adjudication | Added items subdetail adjudication | ||||||
| 0..* | see adjudication | Header-level adjudication | ||||||
| Σ | 0..* | BackboneElement | Adjudication totals | |||||
| Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: Adjudication Value Codes (Example) | |||||
| Σ | 1..1 | Money | Financial total for the category | |||||
| 0..1 | BackboneElement | Payment Details | ||||||
| 1..1 | CodeableConcept | Partial or complete payment Binding: Example Payment Type Codes (Example) | ||||||
| 0..1 | Money | Payment adjustment for non-claim issues | ||||||
| 0..1 | CodeableConcept | Explanation for the adjustment Binding: Payment Adjustment Reason Codes (Example) | ||||||
| 0..1 | date | Expected date of payment | ||||||
| 1..1 | Money | Payable amount after adjustment | ||||||
| 0..1 | Identifier | Business identifier for the payment | ||||||
| 0..1 | CodeableConcept | Funds reserved status Binding: Funds Reservation Codes (Example) | ||||||
| 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (Example) | ||||||
| 0..1 | Attachment | Printed reference or actual form | ||||||
| 0..* | BackboneElement | Note concerning adjudication | ||||||
| 0..1 | positiveInt | Note instance identifier | ||||||
| 0..1 | CodeableConcept | Note purpose Binding: NoteType (Extensible) | ||||||
| 1..1 | string | Note explanatory text | ||||||
| 0..1 | CodeableConcept | Language of the text Binding: All Languages (Required)
| ||||||
| 0..* | Reference(CommunicationRequest) | Request for additional information | ||||||
| 0..* | BackboneElement | Patient insurance information | ||||||
| 1..1 | positiveInt | Insurance instance identifier | ||||||
| 1..1 | boolean | Coverage to be used for adjudication | ||||||
| 1..1 | Reference(Coverage) | Insurance information | ||||||
| 0..1 | string | Additional provider contract number | ||||||
| 0..1 | Reference(ClaimResponse) | Adjudication results | ||||||
| 0..* | BackboneElement | Processing errors | ||||||
| 0..1 | positiveInt | Item sequence number | ||||||
| 0..1 | positiveInt | Detail sequence number | ||||||
| 0..1 | positiveInt | Subdetail sequence number | ||||||
| Σ | 1..1 | CodeableConcept | Error code detailing processing issues Binding: Adjudication Error Codes (Example) | |||||
| Σ | 0..* | string | FHIRPath of element(s) related to issue | |||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A clinical assessment performed when planning treatments and management strategies for a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier | |
| ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (Required) | |
| 0..1 | CodeableConcept | Reason for current status Binding: ClinicalImpression Status Reason (Example) | ||
| Σ | 0..1 | string | Why/how the assessment was performed | |
| Σ | 1..1 | Reference(Patient | Group) | Patient or group assessed | |
| Σ | 0..1 | Reference(Encounter) | The Encounter during which this ClinicalImpression was created | |
| Σ | 0..1 | Time of assessment | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | dateTime | When the assessment was documented | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The clinician performing the assessment | |
| 0..1 | Reference(ClinicalImpression) | Reference to last assessment | ||
| Σ | 0..* | Reference(Condition | AllergyIntolerance) | Relevant impressions of patient state | |
| 0..1 | CodeableConcept | Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change Binding: ClinicalImpression Change Pattern (Example) | ||
| 0..* | uri | Clinical Protocol followed | ||
| 0..1 | string | Summary of the assessment | ||
| 0..* | BackboneElement | Possible or likely findings and diagnoses | ||
| 0..1 | CodeableReference(Condition | Observation | DocumentReference) | What was found Binding: Condition/Problem/Diagnosis Codes (Example) | ||
| 0..1 | string | Which investigations support finding | ||
| 0..* | CodeableConcept | Estimate of likely outcome Binding: Clinical Impression Prognosis (Example) | ||
| 0..* | Reference(RiskAssessment) | RiskAssessment expressing likely outcome | ||
| 0..* | Reference(Any) | Information supporting the clinical impression | ||
| 0..* | Annotation | Comments made about the ClinicalImpression | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure + Rule: Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for this issue | |
| Σ | 1..1 | code | indication | contraindication | interaction | undesirable-effect | warning Binding: Clinical Use Definition Type (Required) | |
| Σ | 0..* | CodeableConcept | A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" Binding: Clinical Use Definition Category (Preferred) | |
| Σ | 0..* | Reference(MedicinalProductDefinition | Medication | ActivityDefinition | PlanDefinition | Device | DeviceDefinition | Substance | NutritionProduct | BiologicallyDerivedProduct) | The medication, product, substance, device, procedure etc. for which this is an indication | |
| Σ | 0..1 | CodeableConcept | Whether this is a current issue or one that has been retired etc Binding: PublicationStatus (Preferred) | |
| ΣC | 0..1 | BackboneElement | Specifics for when this is a contraindication | |
| Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation that is being documented as contraindicating against this item Binding: Disease Symptom Procedure (Example) | |
| Σ | 0..1 | CodeableReference(ObservationDefinition) | The status of the disease or symptom for the contraindication Binding: Disease Status (Example) | |
| Σ | 0..* | CodeableReference(ObservationDefinition) | A comorbidity (concurrent condition) or coinfection Binding: Disease Symptom Procedure (Example) | |
| Σ | 0..* | Reference(ClinicalUseDefinition) | The indication which this is a contraidication for | |
| 0..1 | Expression | An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements | ||
| Σ | 0..* | BackboneElement | Information about use of the product in relation to other therapies described as part of the contraindication | |
| Σ | 1..1 | CodeableConcept | The type of relationship between the product indication/contraindication and another therapy Binding: Therapy Relationship Type (Preferred) | |
| Σ | 1..1 | CodeableReference(MedicinalProductDefinition | Medication | Substance | SubstanceDefinition | NutritionProduct | BiologicallyDerivedProduct | ActivityDefinition) | Reference to a specific medication, substance etc. as part of an indication or contraindication Binding: Therapy (Example) | |
| ΣC | 0..1 | BackboneElement | Specifics for when this is an indication | |
| Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation that is being documented as an indicaton for this item Binding: Disease Symptom Procedure (Example) | |
| Σ | 0..1 | CodeableReference(ObservationDefinition) | The status of the disease or symptom for the indication Binding: Disease Status (Example) | |
| Σ | 0..* | CodeableReference(ObservationDefinition) | A comorbidity or coinfection as part of the indication Binding: Disease Symptom Procedure (Example) | |
| Σ | 0..1 | CodeableReference(ObservationDefinition) | The intended effect, aim or strategy to be achieved Binding: Product Intended Use (Preferred) | |
| Σ | 0..1 | Timing or duration information | ||
| Range | ||||
| string | ||||
| Σ | 0..* | Reference(ClinicalUseDefinition) | An unwanted side effect or negative outcome of the subject of this resource when being used for this indication | |
| 0..1 | Expression | An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements | ||
| Σ | 0..* | see otherTherapy | The use of the medicinal product in relation to other therapies described as part of the indication | |
| ΣC | 0..1 | BackboneElement | Specifics for when this is an interaction | |
| Σ | 0..* | BackboneElement | The specific medication, product, food etc. or laboratory test that interacts | |
| Σ | 1..1 | The specific medication, product, food etc. or laboratory test that interacts Binding: Interactant (Example) | ||
| Reference(MedicinalProductDefinition | Medication | Substance | NutritionProduct | BiologicallyDerivedProduct | ObservationDefinition) | ||||
| CodeableConcept | ||||
| Σ | 0..1 | CodeableConcept | The type of the interaction e.g. drug-drug interaction, drug-lab test interaction Binding: Interaction Type (Example) | |
| Σ | 0..1 | CodeableReference(ObservationDefinition) | The effect of the interaction, for example "reduced gastric absorption of primary medication" Binding: Interaction Effect (Example) | |
| Σ | 0..1 | CodeableConcept | The incidence of the interaction, e.g. theoretical, observed Binding: Interaction Incidence (Example) | |
| Σ | 0..* | CodeableConcept | Actions for managing the interaction Binding: Interaction Management (Example) | |
| Σ | 0..* | Reference(Group) | The population group to which this applies | |
| Σ | 0..* | canonical(Library) | Logic used by the clinical use definition | |
| ΣC | 0..1 | BackboneElement | A possible negative outcome from the use of this treatment | |
| Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation in which the undesirable effect may manifest Binding: Undesirable Effect Symptom (Example) | |
| Σ | 0..1 | CodeableConcept | High level classification of the effect Binding: Undesirable Effect Classification (Example) | |
| Σ | 0..1 | CodeableConcept | How often the effect is seen Binding: Undesirabl Effect Frequency (Example) | |
| ΣC | 0..1 | BackboneElement | Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' | |
| Σ | 0..1 | markdown | A textual definition of this warning, with formatting | |
| Σ | 0..1 | CodeableConcept | A coded or unformatted textual definition of this warning Binding: Warning Type (Example) | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| N | DomainResource | Declares the existence of and describes a code system or code system supplement + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Within a code system definition, all the codes SHALL be unique + Warning: If there is an explicit hierarchy, a hierarchyMeaning should be provided + Warning: If there is an implicit hierarchy, a hierarchyMeaning should be provided + Rule: If the code system content = supplement, it must nominate what it's a supplement for Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||||||
| ΣC | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |||||
| Σ | 0..* | Identifier | Additional identifier for the code system (business identifier) | |||||
| Σ | 0..1 | string | Business version of the code system (Coding.version) | |||||
| ΣTU | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| ΣC | 0..1 | string | Name for this code system (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this code system (human friendly) | |||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
| Σ | 0..1 | dateTime | Date last changed | |||||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| T | 0..1 | markdown | Natural language description of the code system | |||||
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| T | 0..1 | markdown | Why this code system is defined | |||||
| T | 0..1 | markdown | Use and/or publishing restrictions | |||||
| TTU | 0..1 | string | Copyright holder and year(s) | |||||
| TU | 0..1 | date | When the CodeSystem was approved by publisher | |||||
| TU | 0..1 | date | When the CodeSystem was last reviewed by the publisher | |||||
| ΣTU | 0..1 | Period | When the CodeSystem is expected to be used | |||||
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |||||
| TU | 0..* | ContactDetail | Who authored the CodeSystem | |||||
| TU | 0..* | ContactDetail | Who edited the CodeSystem | |||||
| TU | 0..* | ContactDetail | Who reviewed the CodeSystem | |||||
| TU | 0..* | ContactDetail | Who endorsed the CodeSystem | |||||
| TU | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| Σ | 0..1 | boolean | If code comparison is case sensitive | |||||
| Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | |||||
| ΣC | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: Code System Hierarchy Meaning (Required) | |||||
| Σ | 0..1 | boolean | If code system defines a compositional grammar | |||||
| Σ | 0..1 | boolean | If definitions are not stable | |||||
| ΣC | 1..1 | code | not-present | example | fragment | complete | supplement Binding: Code System Content Mode (Required) | |||||
| ΣCTU | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to | |||||
| Σ | 0..1 | unsignedInt | Total concepts in the code system | |||||
| Σ | 0..* | BackboneElement | Filter that can be used in a value set | |||||
| Σ | 1..1 | code | Code that identifies the filter | |||||
| Σ | 0..1 | string | How or why the filter is used | |||||
| Σ | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: Filter Operator (Required) | |||||
| Σ | 1..1 | string | What to use for the value | |||||
| Σ | 0..* | BackboneElement | Additional information supplied about each concept | |||||
| Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations | |||||
| Σ | 0..1 | uri | Formal identifier for the property | |||||
| Σ | 0..1 | string | Why the property is defined, and/or what it conveys | |||||
| Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: Property Type (Required) | |||||
| C | 0..* | BackboneElement | Concepts in the code system | |||||
| C | 1..1 | code | Code that identifies concept | |||||
| 0..1 | string | Text to display to the user | ||||||
| 0..1 | string | Formal definition | ||||||
| C | 0..* | BackboneElement | Additional representations for the concept + Rule: Must have a value for concept.designation.use if concept.designation.additionalUse is present | |||||
| 0..1 | code | Human language of the designation Binding: All Languages (Required)
| ||||||
| C | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (Extensible) | |||||
| CTU | 0..* | Coding | Additional ways how this designation would be used Binding: Designation Use (Extensible) | |||||
| 1..1 | string | The text value for this designation | ||||||
| 0..* | BackboneElement | Property value for the concept | ||||||
| C | 1..1 | code | Reference to CodeSystem.property.code | |||||
| 1..1 | Value of the property for this concept | |||||||
| code | ||||||||
| Coding | ||||||||
| string | ||||||||
| integer | ||||||||
| boolean | ||||||||
| dateTime | ||||||||
| decimal | ||||||||
| C | 0..* | see concept | Child Concepts (is-a/contains/categorizes) | |||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A clinical or business level record of information being transmitted or shared Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique identifier | |
| Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| Σ | 0..* | Reference(Any) | Request fulfilled by this communication | |
| Σ | 0..* | Reference(Any) | Part of referenced event (e.g. Communication, Procedure) | |
| 0..* | Reference(Communication) | Reply to | ||
| ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (Required) | |
| Σ | 0..1 | CodeableConcept | Reason for current status Binding: Communication Not Done Reason (Example) | |
| 0..* | CodeableConcept | Message category Binding: Communication Category (Example) | ||
| Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | |
| 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (Example) | ||
| Σ | 0..1 | Reference(Patient | Group) | Focus of message | |
| 0..1 | CodeableConcept | Description of the purpose/content Binding: Communication Topic (Example) | ||
| 0..* | Reference(Any) | Resources that pertain to this communication | ||
| Σ | 0..1 | Reference(Encounter) | The Encounter during which this Communication was created | |
| 0..1 | dateTime | When sent | ||
| 0..1 | dateTime | When received | ||
| 0..* | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) | Who the information is shared with | ||
| 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) | Who shares the information | ||
| Σ | 0..* | CodeableReference(Any) | Indication for message Binding: SNOMED CT Clinical Findings (Example) | |
| 0..* | BackboneElement | Message payload | ||
| 1..1 | Message part content | |||
| Attachment | ||||
| Reference(Any) | ||||
| CodeableConcept | ||||
| 0..* | Annotation | Comments made about the communication | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A request for information to be sent to a receiver Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique identifier | |
| Σ | 0..* | Reference(Any) | Fulfills plan or proposal | |
| Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | |
| Σ | 0..1 | Identifier | Composite request this is part of | |
| ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (Required) | |
| 0..1 | CodeableConcept | Reason for current status Binding: CommunicationRequest Status Reason (Example) | ||
| ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (Required) | |
| 0..* | CodeableConcept | Message category Binding: Communication Category (Example) | ||
| Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | |
| ?!Σ | 0..1 | boolean | True if request is prohibiting action | |
| 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (Example) | ||
| 0..1 | Reference(Patient | Group) | Focus of message | ||
| 0..* | Reference(Any) | Resources that pertain to this communication request | ||
| Σ | 0..1 | Reference(Encounter) | The Encounter during which this CommunicationRequest was created | |
| 0..* | BackboneElement | Message payload | ||
| 1..1 | Message part content | |||
| Attachment | ||||
| Reference(Any) | ||||
| CodeableConcept | ||||
| Σ | 0..1 | When scheduled | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | dateTime | When request transitioned to being actionable | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who asks for the information to be shared | |
| 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint) | Who to share the information with | ||
| Σ | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint) | Who should share the information | |
| Σ | 0..* | CodeableReference(Any) | Why is communication needed? Binding: v3 Code System ActReason (Example) | |
| 0..* | Annotation | Comments made about communication request | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Compartment Definition for a resource + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 1..1 | uri | Canonical identifier for this compartment definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..1 | string | Business version of the compartment definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 1..1 | string | Name for this compartment definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this compartment definition (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the compartment definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| T | 0..1 | markdown | Why this compartment definition is defined | |
| Σ | 1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare Binding: Compartment Type (Required) | |
| Σ | 1..1 | boolean | Whether the search syntax is supported | |
| Σ | 0..* | BackboneElement | How a resource is related to the compartment | |
| Σ | 1..1 | code | Name of resource type Binding: Resource Types (Required) | |
| Σ | 0..* | string | Search Parameter Name, or chained parameters | |
| 0..1 | string | Additional documentation about the resource and compartment | ||
| 0..1 | uri | Search Param for interpreting $everything.start | ||
| 0..1 | uri | Search Param for interpreting $everything.end | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A set of resources composed into a single coherent clinical statement with clinical attestation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | uri | Canonical identifier for this Composition, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Version-independent identifier for the Composition | |
| Σ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the Composition | |
| ?!Σ | 1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: Composition Status (Required) | |
| Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (Preferred) | |
| Σ | 0..* | CodeableConcept | Categorization of Composition Binding: Referenced Item Category Value Set (Example) | |
| Σ | 0..* | Reference(Any) | Who and/or what the composition is about | |
| Σ | 0..1 | Reference(Encounter) | Context of the Composition | |
| Σ | 1..1 | dateTime | Composition editing time | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | |
| Σ | 0..1 | string | Name for this Composition (computer friendly) | |
| Σ | 1..1 | string | Human Readable name/title | |
| 0..* | Annotation | For any additional notes | ||
| 0..* | BackboneElement | Attests to accuracy of composition | ||
| 1..1 | CodeableConcept | personal | professional | legal | official Binding: Composition Attestation Mode (Preferred) | ||
| 0..1 | dateTime | When the composition was attested | ||
| 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | ||
| Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | |
| 0..* | RelatedArtifact | Relationships to other compositions/documents | ||
| Σ | 0..* | BackboneElement | The clinical service(s) being documented | |
| Σ | 0..1 | Period | The period covered by the documentation | |
| Σ | 0..* | CodeableReference(Any) | The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (Example) | |
| C | 0..* | BackboneElement | Composition is broken into sections + Rule: A section must contain at least one of text, entries, or sub-sections + Rule: A section can only have an emptyReason if it is empty | |
| 0..1 | string | Label for section (e.g. for ToC) | ||
| 0..1 | CodeableConcept | Classification of section (recommended) Binding: Document Section Codes (Example) | ||
| 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | ||
| 0..1 | Reference(Any) | Who/what the section is about, when it is not about the subject of composition | ||
| C | 0..1 | Narrative | Text summary of the section, for human interpretation | |
| 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (Preferred) | ||
| C | 0..* | Reference(Any) | A reference to data that supports this section | |
| C | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (Preferred) | |
| 0..* | see section | Nested Section | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A map from one set of concepts to one or more other concepts + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the concept map | |
| Σ | 0..1 | string | Business version of the concept map | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this concept map (computer friendly) | |
| ΣT | 0..1 | string | Name for this concept map (human friendly) | |
| ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the concept map | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this concept map is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the ConceptMap was approved by publisher | ||
| 0..1 | date | When the ConceptMap was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the ConceptMap is expected to be used | |
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the ConceptMap | ||
| 0..* | ContactDetail | Who edited the ConceptMap | ||
| 0..* | ContactDetail | Who reviewed the ConceptMap | ||
| 0..* | ContactDetail | Who endorsed the ConceptMap | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| ΣC | 0..* | BackboneElement | Additional properties of the mapping + Rule: If the property type is code, a system SHALL be specified | |
| Σ | 1..1 | code | Identifies the property on the mappings, and when referred to in the $translate operation | |
| Σ | 0..1 | uri | Formal identifier for the property | |
| Σ | 0..1 | string | Why the property is defined, and/or what it conveys | |
| ΣC | 1..1 | code | Coding | string | integer | boolean | dateTime | decimal | code Binding: ConceptMap Property Type (Required) | |
| ΣC | 0..1 | canonical(CodeSystem) | The CodeSystem from which code values come | |
| Σ | 0..* | BackboneElement | Definition of an additional attribute to act as a data source or target | |
| Σ | 1..1 | code | Identifies this additional attribute through this resource | |
| Σ | 0..1 | uri | Formal identifier for the data element referred to in this attribte | |
| Σ | 0..1 | string | Why the additional attribute is defined, and/or what the data element it refers to is | |
| Σ | 1..1 | code | code | Coding | string | boolean | Quantity Binding: ConceptMap Attribute Type (Required) | |
| Σ | 0..1 | The source value set that contains the concepts that are being mapped | ||
| uri | ||||
| canonical(ValueSet) | ||||
| Σ | 0..1 | The target value set which provides context for the mappings | ||
| uri | ||||
| canonical(ValueSet) | ||||
| 0..* | BackboneElement | Same source and target systems | ||
| 0..1 | canonical(CodeSystem) | Source system where concepts to be mapped are defined | ||
| 0..1 | canonical(CodeSystem) | Target system that the concepts are to be mapped to | ||
| C | 1..* | BackboneElement | Mappings for a concept from the source set + Rule: If noMap is present, target SHALL NOT be present + Rule: Either code or valueSet SHALL be present but not both. | |
| C | 0..1 | code | Identifies element being mapped | |
| 0..1 | string | Display for the code | ||
| C | 0..1 | canonical(ValueSet) | Identifies the set of concepts being mapped | |
| C | 0..1 | boolean | No mapping to a target concept for this source concept | |
| C | 0..* | BackboneElement | Concept in target system for element + Rule: If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft' + Rule: Either code or valueSet SHALL be present but not both. | |
| C | 0..1 | code | Code that identifies the target element | |
| 0..1 | string | Display for the code | ||
| C | 0..1 | canonical(ValueSet) | Identifies the set of target concepts | |
| ?!C | 1..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) | |
| C | 0..1 | string | Description of status/issues in mapping | |
| 0..* | BackboneElement | Property value for the source -> target mapping | ||
| 1..1 | code | Reference to ConceptMap.property.code | ||
| 1..1 | Value of the property for this concept | |||
| Coding | ||||
| string | ||||
| integer | ||||
| boolean | ||||
| dateTime | ||||
| decimal | ||||
| code | ||||
| C | 0..* | BackboneElement | Other properties required for this mapping + Rule: One of value[x] or valueSet must exist, but not both. | |
| 1..1 | code | A reference to a mapping attribute defined in ConceptMap.additionalAttribute | ||
| C | 0..1 | Value of the referenced data element | ||
| code | ||||
| Coding | ||||
| string | ||||
| boolean | ||||
| Quantity | ||||
| C | 0..1 | canonical(ValueSet) | The mapping depends on a data element with a value from this value set | |
| 0..* | see dependsOn | Other data elements that this mapping also produces | ||
| C | 0..1 | BackboneElement | What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true + Rule: If the mode is 'fixed', either a code or valueSet must be provided, but not both. + Rule: If the mode is 'other-map', a url for the other map must be provided + Rule: If the mode is not 'fixed', code, display and valueSet are not allowed + Rule: If the mode is not 'other-map', relationship must be provided + Rule: If the mode is not 'other-map', otherMap is not allowed | |
| C | 1..1 | code | use-source-code | fixed | other-map Binding: Concept Map Group Unmapped Mode (Required) | |
| C | 0..1 | code | Fixed code when mode = fixed | |
| C | 0..1 | string | Display for the code | |
| C | 0..1 | canonical(ValueSet) | Fixed code set when mode = fixed | |
| ?!C | 0..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) | |
| C | 0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Detailed information about conditions, problems or diagnoses + Warning: If category is problems list item, the clinicalStatus should not be unknown + Rule: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission. Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this condition | |
| ?!ΣC | 1..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved | unknown Binding: Condition Clinical Status Codes (Required) | |
| ?!Σ | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Binding: Condition Verification Status (Required) | |
| C | 0..* | CodeableConcept | problem-list-item | encounter-diagnosis Binding: Condition Category Codes (Preferred) | |
| 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/Diagnosis Severity (Preferred) | ||
| Σ | 0..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/Diagnosis Codes (Example) | |
| Σ | 0..* | CodeableConcept | Anatomical location, if relevant Binding: SNOMED CT Body Structures (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Who has the condition? | |
| Σ | 0..1 | Reference(Encounter) | The Encounter during which this Condition was created | |
| Σ | 0..1 | Estimated or actual date, date-time, or age | ||
| dateTime | ||||
| Age | ||||
| Period | ||||
| Range | ||||
| string | ||||
| C | 0..1 | When in resolution/remission | ||
| dateTime | ||||
| Age | ||||
| Period | ||||
| Range | ||||
| string | ||||
| Σ | 0..1 | dateTime | Date condition was first recorded | |
| Σ | 0..* | BackboneElement | Who or what participated in the activities related to the condition and how they were involved | |
| Σ | 0..1 | CodeableConcept | Type of involvement Binding: Participation Role Type (Extensible) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) | Who or what participated in the activities related to the condition | |
| CTU | 0..* | BackboneElement | Stage/grade, usually assessed formally + Rule: Stage SHALL have summary or assessment | |
| C | 0..1 | CodeableConcept | Simple summary (disease specific) Binding: Condition Stage (Example) | |
| C | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | |
| 0..1 | CodeableConcept | Kind of staging Binding: Condition Stage Type (Example) | ||
| ΣTU | 0..* | CodeableReference(Any) | Supporting evidence for the verification status Binding: SNOMED CT Clinical Findings (Example) | |
| 0..* | Annotation | Additional information about the Condition | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A definition of a condition + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this condition definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the condition definition | |
| Σ | 0..1 | string | Business version of the condition definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this condition definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this condition definition (human friendly) | |
| 0..1 | string | Subordinate title of the event definition | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the condition definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for condition definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| Σ | 1..1 | CodeableConcept | Identification of the condition, problem or diagnosis Binding: Condition/Problem/Diagnosis Codes (Example) | |
| Σ | 0..1 | CodeableConcept | Subjective severity of condition Binding: Condition/Diagnosis Severity (Preferred) | |
| Σ | 0..1 | CodeableConcept | Anatomical location, if relevant Binding: SNOMED CT Body Structures (Example) | |
| Σ | 0..1 | CodeableConcept | Stage/grade, usually assessed formally Binding: Condition Stage (Example) | |
| 0..1 | boolean | Whether Severity is appropriate | ||
| 0..1 | boolean | Whether bodySite is appropriate | ||
| 0..1 | boolean | Whether stage is appropriate | ||
| 0..* | uri | Formal Definition for the condition | ||
| 0..* | BackboneElement | Observations particularly relevant to this condition | ||
| 0..1 | CodeableConcept | Category that is relevant Binding: Observation Category Codes (Preferred) | ||
| 0..1 | CodeableConcept | Code for relevant Observation Binding: LOINC Codes (Example) | ||
| 0..* | BackboneElement | Medications particularly relevant for this condition | ||
| 0..1 | CodeableConcept | Category that is relevant Binding: Medication request category codes (Example) | ||
| 0..1 | CodeableConcept | Code for relevant Medication Binding: SNOMED CT Medication Codes (Example) | ||
| 0..* | BackboneElement | Observation that suggets this condition | ||
| 1..1 | code | sensitive | specific Binding: Condition Precondition Type (Required) | ||
| 1..1 | CodeableConcept | Code for relevant Observation Binding: LOINC Codes (Example) | ||
| 0..1 | Value of Observation | |||
| CodeableConcept | ||||
| Quantity | ||||
| 0..* | Reference(CareTeam) | Appropriate team for this condition | ||
| 0..* | BackboneElement | Questionnaire for this condition | ||
| 1..1 | code | preadmit | diff-diagnosis | outcome Binding: Condition Questionnaire Purpose (Required) | ||
| 1..1 | Reference(Questionnaire) | Specific Questionnaire | ||
| 0..* | BackboneElement | Plan that is appropriate | ||
| 0..1 | CodeableConcept | Use for the plan | ||
| 1..1 | Reference(PlanDefinition) | The actual plan | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifier for this record (external references) | |
| ?!Σ | 1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown Binding: Consent State (Required) | |
| Σ | 0..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: Consent Category Codes (Example) | |
| Σ | 0..1 | Reference(Patient | Practitioner | Group) | Who the consent applies to | |
| Σ | 0..1 | date | Fully executed date of the consent | |
| Σ | 0..1 | Period | Effective period for this Consent | |
| Σ | 0..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is granting rights according to the policy and rules | |
| Σ | 0..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
| 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Consent workflow management | ||
| 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Consent Enforcer | ||
| 0..* | Attachment | Source from which this consent is taken | ||
| 0..* | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken | ||
| 0..* | CodeableConcept | Regulations establishing base Consent Binding: Consent PolicyRule Codes (Example) | ||
| 0..1 | BackboneElement | Computable version of the backing policy | ||
| 0..1 | Reference(Any) | Reference backing policy resource | ||
| 0..1 | url | URL to a computable backing policy | ||
| 0..* | Reference(DocumentReference) | Human Readable Policy | ||
| Σ | 0..* | BackboneElement | Consent Verified by patient or family | |
| Σ | 1..1 | boolean | Has been verified | |
| 0..1 | CodeableConcept | Business case of verification Binding: Consent Vefication Codes (Example) | ||
| 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Person conducting verification | ||
| 0..1 | Reference(Patient | RelatedPerson) | Person who verified | ||
| 0..* | dateTime | When consent verified | ||
| ?!Σ | 0..1 | code | deny | permit Binding: Consent Provision Type (Required) | |
| Σ | 0..* | BackboneElement | Constraints to the base Consent.policyRule/Consent.policy | |
| Σ | 0..1 | Period | Timeframe for this provision | |
| 0..* | BackboneElement | Who|what controlled by this provision (or group, by role) | ||
| 0..1 | CodeableConcept | How the actor is involved Binding: Participation Role Type (Extensible) | ||
| 0..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||
| Σ | 0..* | CodeableConcept | Actions controlled by this provision Binding: Consent Action Codes (Example) | |
| Σ | 0..* | Coding | Security Labels that define affected resources Binding: Example set of Security Labels (Example) | |
| Σ | 0..* | Coding | Context of activities covered by this provision Binding: PurposeOfUse (Extensible) | |
| Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc Binding: Consent Content Class (Preferred) | |
| Σ | 0..* | Coding | e.g. Resource Type, Profile, etc Binding: Resource Types (Extensible) | |
| Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: Consent Content Codes (Example) | |
| Σ | 0..1 | Period | Timeframe for data controlled by this provision | |
| Σ | 0..* | BackboneElement | Data controlled by this provision | |
| Σ | 1..1 | code | instance | related | dependents | authoredby Binding: Consent Data Meaning (Required) | |
| Σ | 1..1 | Reference(Any) | The actual data reference | |
| 0..1 | Expression | A computable expression of the consent | ||
| 0..* | see provision | Nested Exception Provisions | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Legal Agreement Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Contract number | |
| 0..1 | uri | Basal definition | ||
| Σ | 0..1 | string | Business edition | |
| ?!Σ | 0..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable + Binding: Contract Resource Status Codes (Required) | |
| 0..1 | CodeableConcept | Negotiation status Binding: Contract Resource Legal State codes (Extensible) | ||
| 0..1 | Reference(Contract) | Source Contract Definition | ||
| 0..1 | uri | External Contract Definition | ||
| 0..1 | CodeableConcept | Content derived from the basal information Binding: Contract Content Derivation Codes (Example) | ||
| Σ | 0..1 | dateTime | When this Contract was issued | |
| Σ | 0..1 | Period | Effective time | |
| 0..1 | CodeableConcept | Contract cessation cause Binding: Contract Resource Expiration Type codes (Example) | ||
| Σ | 0..* | Reference(Any) | Contract Target Entity | |
| 0..* | Reference(Organization) | Authority under which this Contract has standing | ||
| 0..* | Reference(Location) | A sphere of control governed by an authoritative jurisdiction, organization, or person | ||
| 0..* | Reference(Location) | Specific Location | ||
| Σ | 0..1 | string | Computer friendly designation | |
| Σ | 0..1 | string | Human Friendly name | |
| 0..1 | string | Subordinate Friendly name | ||
| 0..* | string | Acronym or short name | ||
| 0..1 | Reference(Patient | Practitioner | PractitionerRole | Organization) | Source of Contract | ||
| 0..1 | CodeableConcept | Range of Legal Concerns Binding: Contract Resource Scope codes (Example) | ||
| 0..1 | Focus of contract interest | |||
| CodeableConcept | ||||
| Reference(Any) | ||||
| Σ | 0..1 | CodeableConcept | Legal instrument category Binding: Contract Type Codes (Example) | |
| Σ | 0..* | CodeableConcept | Subtype within the context of type Binding: Contract Subtype Codes (Example) | |
| 0..1 | BackboneElement | Contract precursor content | ||
| 1..1 | CodeableConcept | Content structure and use Binding: Contract Resource Definition Type codes (Example) | ||
| 0..1 | CodeableConcept | Detailed Content Type Definition Binding: Contract Resource Definition Subtype codes (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Publisher Entity | ||
| 0..1 | dateTime | When published | ||
| 1..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable + Binding: Contract Resource Publication Status codes (Required) | ||
| 0..1 | markdown | Publication Ownership | ||
| 0..* | BackboneElement | Contract Term List | ||
| Σ | 0..1 | Identifier | Contract Term Number | |
| Σ | 0..1 | dateTime | Contract Term Issue Date Time | |
| Σ | 0..1 | Period | Contract Term Effective Time | |
| 0..1 | Term Concern | |||
| CodeableConcept | ||||
| Reference(Any) | ||||
| 0..1 | CodeableConcept | Contract Term Type or Form Binding: Contract Term Type Codes (Example) | ||
| 0..1 | CodeableConcept | Contract Term Type specific classification Binding: Contract Term Subtype Codes (Example) | ||
| Σ | 0..1 | string | Term Statement | |
| 0..* | BackboneElement | Protection for the Term | ||
| 0..* | unsignedInt | Link to Security Labels | ||
| 1..1 | Coding | Confidentiality Protection Binding: Contract Resource Scope codes (Example) | ||
| 0..* | Coding | Applicable Policy Binding: Contract Resource Scope codes (Example) | ||
| 0..* | Coding | Handling Instructions Binding: Contract Resource Security Control codes (Example) | ||
| 1..1 | BackboneElement | Context of the Contract term | ||
| 0..* | Identifier | Offer business ID | ||
| 0..* | BackboneElement | Offer Recipient | ||
| 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Referenced entity | ||
| 1..1 | CodeableConcept | Participant engagement type Binding: Contract Resource Party Role codes (Example) | ||
| Σ | 0..1 | Reference(Any) | Negotiable offer asset | |
| 0..1 | CodeableConcept | Contract Offer Type or Form Binding: Contract Term Type Codes (Example) | ||
| 0..1 | CodeableConcept | Accepting party choice Binding: ActConsentDirective (Extensible) | ||
| 0..* | CodeableConcept | How decision is conveyed Binding: Contract Resource Decision Mode codes (Example) | ||
| 0..* | BackboneElement | Response to offer text | ||
| 1..1 | The actual answer response | |||
| boolean | ||||
| decimal | ||||
| integer | ||||
| date | ||||
| dateTime | ||||
| time | ||||
| string | ||||
| uri | ||||
| Attachment | ||||
| Coding | ||||
| Quantity | ||||
| Reference(Any) | ||||
| 0..1 | string | Human readable offer text | ||
| 0..* | string | Pointer to text | ||
| 0..* | unsignedInt | Offer restriction numbers | ||
| 0..* | BackboneElement | Contract Term Asset List | ||
| 0..1 | CodeableConcept | Range of asset Binding: Contract Resource Asset Scope codes (Example) | ||
| 0..* | CodeableConcept | Asset category Binding: Contract Resource Asset Type codes (Example) | ||
| 0..* | Reference(Any) | Associated entities | ||
| 0..* | CodeableConcept | Asset sub-category Binding: Contract Resource Asset Sub-Type codes (Example) | ||
| 0..1 | Coding | Kinship of the asset Binding: Consent Content Class (Extensible) | ||
| 0..* | BackboneElement | Circumstance of the asset | ||
| 0..1 | Reference(Any) | Creator,custodian or owner | ||
| 0..* | CodeableConcept | Codeable asset context Binding: Contract Resource Asset Context codes (Example) | ||
| 0..1 | string | Context description | ||
| 0..1 | string | Quality desctiption of asset | ||
| 0..* | CodeableConcept | Asset availability types Binding: Contract Resource Asset Availiability codes (Example) | ||
| 0..* | Period | Time period of the asset | ||
| 0..* | Period | Time period | ||
| 0..1 | string | Asset clause or question text | ||
| 0..* | string | Pointer to asset text | ||
| 0..* | see answer | Response to assets | ||
| 0..* | unsignedInt | Asset restriction numbers | ||
| 0..* | BackboneElement | Contract Valued Item List | ||
| 0..1 | Contract Valued Item Type | |||
| CodeableConcept | ||||
| Reference(Any) | ||||
| 0..1 | Identifier | Contract Valued Item Number | ||
| 0..1 | dateTime | Contract Valued Item Effective Tiem | ||
| 0..1 | SimpleQuantity | Count of Contract Valued Items | ||
| 0..1 | Money | Contract Valued Item fee, charge, or cost | ||
| 0..1 | decimal | Contract Valued Item Price Scaling Factor | ||
| 0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | ||
| 0..1 | Money | Total Contract Valued Item Value | ||
| 0..1 | string | Terms of valuation | ||
| 0..1 | dateTime | When payment is due | ||
| 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will make payment | ||
| 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who will receive payment | ||
| 0..* | string | Pointer to specific item | ||
| 0..* | unsignedInt | Security Labels that define affected terms | ||
| 0..* | BackboneElement | Entity being ascribed responsibility | ||
| ?! | 0..1 | boolean | True if the term prohibits the action | |
| 1..1 | CodeableConcept | Type or form of the action Binding: Contract Action Codes (Example) | ||
| 0..* | BackboneElement | Entity of the action | ||
| 1..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Entity of the action | ||
| 0..1 | CodeableConcept | Role type of the agent Binding: Contract Actor Role Codes (Example) | ||
| 1..1 | CodeableConcept | Purpose for the Contract Term Action Binding: PurposeOfUse (Example) | ||
| 0..* | string | Pointer to specific item | ||
| 1..1 | CodeableConcept | State of the action Binding: Contract Resource Action Status codes (Example) | ||
| 0..1 | Reference(Encounter | EpisodeOfCare) | Episode associated with action | ||
| 0..* | string | Pointer to specific item | ||
| 0..1 | When action happens | |||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| 0..* | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Group | Organization) | Who asked for action | ||
| 0..* | string | Pointer to specific item | ||
| 0..* | CodeableConcept | Kind of service performer Binding: Participation Role Type (Example) | ||
| 0..1 | CodeableConcept | Competency of the performer Binding: Security Role Type (Example) | ||
| 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole | CareTeam | Device | Substance | Organization | Location) | Actor that wil execute (or not) the action | ||
| 0..* | string | Pointer to specific item | ||
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) | Why is action (not) needed? Binding: PurposeOfUse (Example) | ||
| 0..* | string | Pointer to specific item | ||
| 0..* | Annotation | Comments about the action | ||
| 0..* | unsignedInt | Action restriction numbers | ||
| 0..* | see term | Nested Contract Term Group | ||
| 0..* | Reference(Any) | Extra Information | ||
| 0..* | Reference(Provenance) | Key event in Contract History | ||
| 0..* | BackboneElement | Contract Signatory | ||
| 1..1 | Coding | Contract Signatory Role Binding: Contract Signer Type Codes (Preferred) | ||
| 1..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Contract Signatory Party | ||
| 1..* | Signature | Contract Documentation Signature | ||
| 0..* | BackboneElement | Contract Friendly Language | ||
| 1..1 | Easily comprehended representation of this Contract | |||
| Attachment | ||||
| Reference(Composition | DocumentReference | QuestionnaireResponse) | ||||
| 0..* | BackboneElement | Contract Legal Language | ||
| 1..1 | Contract Legal Text | |||
| Attachment | ||||
| Reference(Composition | DocumentReference | QuestionnaireResponse) | ||||
| 0..* | BackboneElement | Computable Contract Language | ||
| 1..1 | Computable Contract Rules | |||
| Attachment | ||||
| Reference(DocumentReference) | ||||
| 0..1 | Binding Contract | |||
| Attachment | ||||
| Reference(Composition | DocumentReference | QuestionnaireResponse | Contract) | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Insurance or medical plan or a payment agreement Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier(s) for this coverage | |
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| Σ | 1..1 | code | insurance | self-pay | other Binding: Kind (Required) | |
| 0..* | BackboneElement | Self-pay parties and responsibility | ||
| Σ | 1..1 | Reference(Patient | RelatedPerson | Organization) | Parties performing self-payment | |
| Σ | 0..1 | string | Party's responsibility | |
| Σ | 0..1 | CodeableConcept | Coverage category such as medical or accident Binding: Coverage Type and Self-Pay Codes (Preferred) | |
| Σ | 0..1 | Reference(Patient | RelatedPerson | Organization) | Owner of the policy | |
| Σ | 0..1 | Reference(Patient | RelatedPerson) | Subscriber to the policy | |
| Σ | 0..* | Identifier | ID assigned to the subscriber | |
| Σ | 1..1 | Reference(Patient) | Plan beneficiary | |
| Σ | 0..1 | string | Dependent number | |
| 0..1 | CodeableConcept | Beneficiary relationship to the subscriber Binding: SubscriberPolicyholder Relationship Codes (Extensible) | ||
| Σ | 0..1 | Period | Coverage start and end dates | |
| Σ | 0..1 | Reference(Organization) | Issuer of the policy | |
| 0..* | BackboneElement | Additional coverage classifications | ||
| Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Binding: Coverage Class Codes (Extensible) | |
| Σ | 1..1 | Identifier | Value associated with the type | |
| Σ | 0..1 | string | Human readable description of the type and value | |
| Σ | 0..1 | positiveInt | Relative order of the coverage | |
| Σ | 0..1 | string | Insurer network | |
| 0..* | BackboneElement | Patient payments for services/products | ||
| Σ | 0..1 | CodeableConcept | Cost category Binding: Coverage Copay Type Codes (Extensible) | |
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||
| 0..1 | CodeableConcept | In or out of network Binding: Network Type Codes (Example) | ||
| 0..1 | CodeableConcept | Individual or family Binding: Unit Type Codes (Example) | ||
| 0..1 | CodeableConcept | Annual or lifetime Binding: Benefit Term Codes (Example) | ||
| Σ | 0..1 | The amount or percentage due from the beneficiary | ||
| SimpleQuantity | ||||
| Money | ||||
| 0..* | BackboneElement | Exceptions for patient payments | ||
| Σ | 1..1 | CodeableConcept | Exception category Binding: Example Coverage Financial Exception Codes (Example) | |
| Σ | 0..1 | Period | The effective period of the exception | |
| 0..1 | boolean | Reimbursement to insurer | ||
| 0..* | Reference(Contract) | Contract details | ||
| 0..1 | Reference(InsurancePlan) | Insurance plan details | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | CoverageEligibilityRequest resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier for coverage eligiblity request | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| 0..1 | CodeableConcept | Desired processing priority Binding: Process Priority Codes (Example) | ||
| Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: Eligibility Request Purpose (Required) | |
| Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | |
| 0..* | BackboneElement | Event information | ||
| 1..1 | CodeableConcept | Specific event Binding: Dates Type Codes (Example) | ||
| 1..1 | Occurance date or period | |||
| dateTime | ||||
| Period | ||||
| 0..1 | Estimated date or dates of service | |||
| date | ||||
| Period | ||||
| Σ | 1..1 | dateTime | Creation date | |
| 0..1 | Reference(Practitioner | PractitionerRole) | Author | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request | ||
| Σ | 1..1 | Reference(Organization) | Coverage issuer | |
| 0..1 | Reference(Location) | Servicing facility | ||
| 0..* | BackboneElement | Supporting information | ||
| 1..1 | positiveInt | Information instance identifier | ||
| 1..1 | Reference(Any) | Data to be provided | ||
| 0..1 | boolean | Applies to all items | ||
| 0..* | BackboneElement | Patient insurance information | ||
| 0..1 | boolean | Applicable coverage | ||
| 1..1 | Reference(Coverage) | Insurance information | ||
| 0..1 | string | Additional provider contract number | ||
| 0..* | BackboneElement | Item to be evaluated for eligibiity | ||
| 0..* | positiveInt | Applicable exception or supporting information | ||
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Product or service billing modifiers Binding: Modifier type Codes (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Perfoming practitioner | ||
| 0..1 | SimpleQuantity | Count of products or services | ||
| 0..1 | Money | Fee, charge or cost per item | ||
| 0..1 | Reference(Location | Organization) | Servicing facility | ||
| 0..* | BackboneElement | Applicable diagnosis | ||
| 0..1 | Nature of illness or problem Binding: ICD-10 Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Condition) | ||||
| 0..* | Reference(Any) | Product or service details | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | CoverageEligibilityResponse resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier for coverage eligiblity request | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| Σ | 1..* | code | auth-requirements | benefits | discovery | validation Binding: Eligibility Response Purpose (Required) | |
| Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | |
| 0..* | BackboneElement | Event information | ||
| 1..1 | CodeableConcept | Specific event Binding: Dates Type Codes (Example) | ||
| 1..1 | Occurance date or period | |||
| dateTime | ||||
| Period | ||||
| 0..1 | Estimated date or dates of service | |||
| date | ||||
| Period | ||||
| Σ | 1..1 | dateTime | Response creation date | |
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the request | ||
| Σ | 1..1 | Reference(CoverageEligibilityRequest) | Eligibility request reference | |
| Σ | 1..1 | code | queued | complete | error | partial Binding: Eligibility Outcome (Required) | |
| 0..1 | string | Disposition Message | ||
| Σ | 1..1 | Reference(Organization) | Coverage issuer | |
| 0..* | BackboneElement | Patient insurance information | ||
| Σ | 1..1 | Reference(Coverage) | Insurance information | |
| 0..1 | boolean | Coverage inforce indicator | ||
| 0..1 | Period | When the benefits are applicable | ||
| C | 0..* | BackboneElement | Benefits and authorization details + Rule: SHALL contain a category or a billcode but not both. | |
| C | 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | |
| C | 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | |
| 0..* | CodeableConcept | Product or service billing modifiers Binding: Modifier type Codes (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Performing practitioner | ||
| 0..1 | boolean | Excluded from the plan | ||
| 0..1 | string | Short name for the benefit | ||
| 0..1 | string | Description of the benefit or services covered | ||
| 0..1 | CodeableConcept | In or out of network Binding: Network Type Codes (Example) | ||
| 0..1 | CodeableConcept | Individual or family Binding: Unit Type Codes (Example) | ||
| 0..1 | CodeableConcept | Annual or lifetime Binding: Benefit Term Codes (Example) | ||
| 0..* | BackboneElement | Benefit Summary | ||
| 1..1 | CodeableConcept | Benefit classification Binding: Benefit Type Codes (Example) | ||
| 0..1 | Benefits allowed | |||
| unsignedInt | ||||
| string | ||||
| Money | ||||
| 0..1 | Benefits used | |||
| unsignedInt | ||||
| string | ||||
| Money | ||||
| 0..1 | boolean | Authorization required flag | ||
| 0..* | CodeableConcept | Type of required supporting materials Binding: CoverageEligibilityResponse Auth Support Codes (Example) | ||
| 0..1 | uri | Preauthorization requirements endpoint | ||
| 0..1 | string | Preauthorization reference | ||
| 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (Example) | ||
| 0..* | BackboneElement | Processing errors | ||
| Σ | 1..1 | CodeableConcept | Error code detailing processing issues Binding: Adjudication Error Codes (Example) | |
| Σ | 0..* | string | FHIRPath of element(s) related to issue | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Clinical issue with action Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique id for the detected issue | |
| ?!Σ | 1..1 | code | preliminary | final | entered-in-error | mitigated Binding: Detected Issue Status (Required) | |
| 0..* | CodeableConcept | Type of detected issue, e.g. drug-drug, duplicate therapy, etc Binding: Detected Issue Category (Preferred) | ||
| Σ | 0..1 | CodeableConcept | Specific type of detected issue, e.g. drug-drug, duplicate therapy, etc Binding: Detected Issue Category (Preferred) | |
| Σ | 0..1 | code | high | moderate | low Binding: Detected Issue Severity (Required) | |
| Σ | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Associated subject | |
| Σ | 0..1 | Reference(Encounter) | Encounter detected issue is part of | |
| Σ | 0..1 | When identified | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Device) | The provider or device that identified the issue | |
| Σ | 0..* | Reference(Any) | Problem resource | |
| 0..* | BackboneElement | Supporting evidence | ||
| 0..* | CodeableConcept | Manifestation Binding: Manifestation and Symptom Codes (Example) | ||
| 0..* | Reference(Any) | Supporting information | ||
| 0..1 | markdown | Description and context | ||
| 0..1 | uri | Authority for issue | ||
| 0..* | BackboneElement | Step taken to address | ||
| 1..1 | CodeableConcept | What mitigation? Binding: Detected Issue Mitigation Action (Preferred) | ||
| 0..1 | dateTime | Date committed | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Who is committing? | ||
| 0..* | Annotation | Additional notes about the mitigation | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Item used in healthcare + Rule: only one Device.name.display SHALL be true when there is more than one Device.name Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Instance identifier | ||
| 0..1 | string | The name used to display by default when the device is referenced | ||
| 0..1 | CodeableReference(DeviceDefinition) | The reference to the definition for the device | ||
| Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | |
| Σ | 1..1 | string | Mandatory fixed portion of UDI | |
| Σ | 1..1 | uri | UDI Issuing Organization | |
| 0..1 | uri | Regional UDI authority | ||
| Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | |
| Σ | 0..1 | string | UDI Human Readable Barcode String | |
| 0..1 | code | barcode | rfid | manual | card | self-reported | electronic-transmission | unknown Binding: UDI Entry Type (Required) | ||
| ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIR Device Status (Required) | |
| 0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: FHIR Device Availability Status (Extensible) | ||
| 0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | ||
| 0..1 | string | Name of device manufacturer | ||
| 0..1 | dateTime | Date when the device was made | ||
| 0..1 | dateTime | Date and time of expiry of this device (if applicable) | ||
| 0..1 | string | Lot number of manufacture | ||
| 0..1 | string | Serial number assigned by the manufacturer | ||
| C | 0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient | |
| Σ | 1..1 | string | The term that names the device | |
| Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: Device Name Type (Required) | |
| ?!ΣC | 0..1 | boolean | The preferred device name | |
| 0..1 | string | The manufacturer's model number for the device | ||
| 0..1 | string | The part number or catalog number of the device | ||
| 0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: FHIR Device Category (Example) | ||
| 0..* | CodeableConcept | The kind or type of device Binding: Device Type (Example) | ||
| 0..* | BackboneElement | The actual design of the device or software version running on the device | ||
| 0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal Binding: Device Version Type (Example) | ||
| 0..1 | Identifier | The hardware or software module of the device to which the version applies | ||
| 0..1 | dateTime | The date the version was installed on the device | ||
| 1..1 | string | The version text | ||
| 0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | ||
| 0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: Device Specification Category (Example) | ||
| 1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to Binding: Device Specification Type (Example) | ||
| 0..1 | string | Specific form or variant of the standard | ||
| 0..* | BackboneElement | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | ||
| 1..1 | CodeableConcept | Code that specifies the property being represented Binding: Device Property Type (Example) | ||
| 1..1 | Value of the property | |||
| Quantity | ||||
| CodeableConcept | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| Range | ||||
| Attachment | ||||
| 0..1 | CodeableConcept | The designated condition for performing a task Binding: FHIR Device Operation Mode (Example) | ||
| 0..1 | Count | The series of occurrences that repeats during the operation of the device | ||
| 0..1 | Duration | A measurement of time during the device's operation (e.g., days, hours, mins, etc.) | ||
| 0..1 | Reference(Organization) | Organization responsible for device | ||
| 0..* | ContactPoint | Details for human/organization for support | ||
| 0..1 | Reference(Location) | Where the device is found | ||
| 0..1 | uri | Network address to contact device | ||
| 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services provided by the device | ||
| 0..* | CodeableReference(Device) | Linked device acting as a communication/data collector, translator or controller | ||
| 0..* | Annotation | Device notes and comments | ||
| Σ | 0..* | CodeableConcept | Safety Characteristics of Device Binding: Device Safety (Example) | |
| 0..1 | Reference(Device) | The higher level or encompassing device that this device is a logical part of | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ΣD | DomainResource | A record of association or dissociation of a device with a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Instance identifier | |
| Σ | 1..1 | Reference(Device) | Reference to the devices associated with the patient or group | |
| Σ | 0..* | CodeableConcept | Describes the relationship between the device and subject | |
| Σ | 1..1 | CodeableConcept | implanted | explanted | attached | entered-in-error | unknown Binding: DeviceAssociation Status Codes (Required) | |
| Σ | 0..* | CodeableConcept | The reasons given for the current association status Binding: DeviceAssociation Status Reason Codes (Required) | |
| Σ | 0..1 | Reference(Patient | Group | Practitioner | RelatedPerson | Device) | The individual, group of individuals or device that the device is on or associated with | |
| Σ | 0..1 | Reference(BodyStructure) | Current anatomical location of the device in/on subject | |
| Σ | 0..1 | Period | Begin and end dates and times for the device association | |
| Σ | 0..* | BackboneElement | The details about the device when it is in use to describe its operation | |
| Σ | 1..1 | CodeableConcept | Device operational condition Binding: FHIR Device Association Operation Status (Example) | |
| Σ | 0..* | Reference(Patient | Practitioner | RelatedPerson) | The individual performing the action enabled by the device | |
| Σ | 0..1 | Period | Begin and end dates and times for the device's operation | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An instance of a medical-related component of a medical device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..1 | markdown | Additional information to describe the device | ||
| Σ | 0..* | Identifier | Instance identifier | |
| 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||
| 1..1 | string | The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier | ||
| 1..1 | uri | The organization that assigns the identifier algorithm | ||
| 1..1 | uri | The jurisdiction to which the deviceIdentifier applies | ||
| 0..* | BackboneElement | Indicates whether and when the device is available on the market | ||
| 1..1 | Period | Begin and end dates for the commercial distribution of the device | ||
| 1..1 | uri | National state or territory where the device is commercialized | ||
| 0..* | BackboneElement | Regulatory identifier(s) associated with this device | ||
| 1..1 | code | basic | master | license Binding: Device Definition Regulatory Identifier Type (Required) | ||
| 1..1 | string | The identifier itself | ||
| 1..1 | uri | The organization that issued this identifier | ||
| 1..1 | uri | The jurisdiction to which the deviceIdentifier applies | ||
| 0..1 | string | The part number or catalog number of the device | ||
| Σ | 0..1 | Reference(Organization) | Name of device manufacturer | |
| Σ | 0..* | BackboneElement | The name or names of the device as given by the manufacturer | |
| Σ | 1..1 | string | A name that is used to refer to the device | |
| Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: Device Name Type (Required) | |
| Σ | 0..1 | string | The catalog or model number for the device for example as defined by the manufacturer | |
| Σ | 0..* | BackboneElement | What kind of device or device system this is | |
| Σ | 1..1 | CodeableConcept | A classification or risk class of the device model Binding: Device Type (Example) | |
| 0..* | RelatedArtifact | Further information qualifying this classification of the device model | ||
| Σ | 0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | |
| Σ | 0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance Binding: Device Specification Category (Example) | |
| Σ | 1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to the Device Specification type Binding: Device Specification Type (Example) | |
| Σ | 0..* | string | The specific form or variant of the standard, specification or formal guidance | |
| 0..* | RelatedArtifact | Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance | ||
| Σ | 0..* | BackboneElement | A device, part of the current one | |
| Σ | 1..1 | Reference(DeviceDefinition) | Reference to the part | |
| 0..1 | integer | Number of occurrences of the part | ||
| 0..* | BackboneElement | Information about the packaging of the device, i.e. how the device is packaged | ||
| 0..1 | Identifier | Business identifier of the packaged medication | ||
| 0..1 | CodeableConcept | A code that defines the specific type of packaging | ||
| 0..1 | integer | The number of items contained in the package (devices or sub-packages) | ||
| 0..* | BackboneElement | An organization that distributes the packaged device | ||
| 0..1 | string | Distributor's human-readable name | ||
| 0..* | Reference(Organization) | Distributor as an Organization resource | ||
| 0..* | see udiDeviceIdentifier | Unique Device Identifier (UDI) Barcode string on the packaging | ||
| 0..* | see packaging | Allows packages within packages | ||
| 0..* | BackboneElement | The version of the device or software | ||
| 0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal | ||
| 0..1 | Identifier | The hardware or software module of the device to which the version applies | ||
| 1..1 | string | The version text | ||
| Σ | 0..* | CodeableConcept | Safety characteristics of the device Binding: Device Safety (Example) | |
| 0..* | ProductShelfLife | Shelf Life and storage information | ||
| 0..* | CodeableConcept | Language code for the human-readable text strings produced by the device (all supported) | ||
| 0..* | BackboneElement | Inherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc | ||
| 1..1 | CodeableConcept | Code that specifies the property being represented Binding: Device Property Type (Example) | ||
| 1..1 | Value of the property | |||
| Quantity | ||||
| CodeableConcept | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| Range | ||||
| Attachment | ||||
| 0..1 | Reference(Organization) | Organization responsible for device | ||
| 0..* | ContactPoint | Details for human/organization for support | ||
| 0..* | BackboneElement | An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device | ||
| 1..1 | Coding | The type indicates the relationship of the related device to the device instance Binding: Device Definition Relation Type (Extensible) | ||
| 1..1 | CodeableReference(DeviceDefinition) | A reference to the linked device | ||
| 0..* | Annotation | Device notes and comments | ||
| 0..* | BackboneElement | A substance used to create the material(s) of which the device is made | ||
| 1..1 | CodeableConcept | A relevant substance that the device contains, may contain, or is made of | ||
| 0..1 | boolean | Indicates an alternative material of the device | ||
| 0..1 | boolean | Whether the substance is a known or suspected allergen | ||
| 0..* | code | lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version Binding: Device Production Identifier In UDI (Required) | ||
| 0..1 | BackboneElement | Information aimed at providing directions for the usage of this model of device | ||
| 0..* | UsageContext | The circumstances that form the setting for using the device | ||
| 0..1 | markdown | Detailed written and visual directions for the user on how to use the device | ||
| 0..* | RelatedArtifact | A source of information or reference for this guideline | ||
| 0..* | CodeableConcept | A clinical condition for which the device was designed to be used | ||
| 0..* | CodeableConcept | A specific situation when a device should not be used because it may cause harm | ||
| 0..* | CodeableConcept | Specific hazard alert information that a user needs to know before using the device | ||
| 0..1 | string | A description of the general purpose or medical use of the device or its function | ||
| 0..1 | BackboneElement | Tracking of latest field safety corrective action | ||
| 1..1 | boolean | Whether the corrective action was a recall | ||
| 0..1 | code | model | lot-numbers | serial-numbers Binding: Device Corrective Action Scope (Required) | ||
| 1..1 | Period | Start and end dates of the corrective action | ||
| 0..* | BackboneElement | Billing code or reference associated with the device | ||
| 1..1 | CodeableReference(ChargeItemDefinition) | The code or reference for the charge item | ||
| 1..1 | Quantity | Coefficient applicable to the billing code | ||
| 0..1 | Period | A specific time period in which this charge item applies | ||
| 0..* | UsageContext | The context to which this charge item applies | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A record of dispensation of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for this dispensation | |
| 0..* | Reference(CarePlan | DeviceRequest) | The order or request that this dispense is fulfilling | ||
| 0..* | Reference(Procedure) | The bigger event that this dispense is a part of | ||
| ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: DeviceDispense Status Codes (Required) | |
| 0..1 | CodeableReference(DetectedIssue) | Why a dispense was or was not performed Binding: DeviceDispense Status Reason Codes (Example) | ||
| 0..* | CodeableConcept | Type of device dispense | ||
| Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | What device was supplied | |
| Σ | 1..1 | Reference(Patient | Practitioner) | Who the dispense is for | |
| 0..1 | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the device or where the medication was delivered | ||
| 0..1 | Reference(Encounter) | Encounter associated with event | ||
| 0..* | Reference(Any) | Information that supports the dispensing of the device | ||
| 0..* | BackboneElement | Who performed event | ||
| 0..1 | CodeableConcept | Who performed the dispense and what they did | ||
| 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | ||
| 0..1 | Reference(Location) | Where the dispense occurred | ||
| 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc | ||
| 0..1 | SimpleQuantity | Amount dispensed | ||
| Σ | 0..1 | dateTime | When product was packaged and reviewed | |
| 0..1 | dateTime | When product was given out | ||
| 0..1 | Reference(Location) | Where the device was sent or should be sent | ||
| 0..* | Annotation | Information about the dispense | ||
| 0..1 | markdown | Full representation of the usage instructions | ||
| 0..* | Reference(Provenance) | A list of relevant lifecycle events | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Measurement, calculation or setting capability of a medical device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Instance identifier | |
| Σ | 1..1 | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting Binding: Device Metric and Component Types (Preferred) | |
| Σ | 0..1 | CodeableConcept | Unit of Measure for the Metric Binding: UCUM Codes (Preferred) | |
| Σ | 1..1 | Reference(Device) | Describes the link to the Device | |
| Σ | 0..1 | code | on | off | standby | entered-in-error Binding: Device Metric Operational Status (Required) | |
| 0..1 | code | Color name (from CSS4) or #RRGGBB code Binding: Color Codes (Names or RGB Values) (Required) | ||
| Σ | 1..1 | code | measurement | setting | calculation | unspecified Binding: Device Metric Category (Required) | |
| 0..1 | Quantity | Indicates how often the metric is taken or recorded | ||
| 0..* | BackboneElement | Describes the calibrations that have been performed or that are required to be performed | ||
| 0..1 | code | unspecified | offset | gain | two-point Binding: Device Metric Calibration Type (Required) | ||
| 0..1 | code | not-calibrated | calibration-required | calibrated | unspecified Binding: Device Metric Calibration State (Required) | ||
| 0..1 | instant | Describes the time last calibration has been performed | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Medical device request Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Request identifier | |
| Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| Σ | 0..* | Reference(Any) | What request fulfills | |
| Σ | 0..* | Reference(DeviceRequest) | What request replaces | |
| Σ | 0..1 | Identifier | Identifier of composite request | |
| ?!Σ | 0..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (Required) | |
| ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (Required) | |
| Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | |
| ?!Σ | 0..1 | boolean | True if the request is to stop or not to start using the device | |
| Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | Device requested Binding: Device Type (Example) | |
| 0..1 | integer | Quantity of devices to supply | ||
| 0..* | BackboneElement | Device details | ||
| 0..1 | CodeableConcept | Device detail Binding: ParameterCode (Example) | ||
| 0..1 | Value of detail | |||
| CodeableConcept | ||||
| Quantity | ||||
| Range | ||||
| boolean | ||||
| Σ | 1..1 | Reference(Patient | Group | Location | Device) | Focus of request | |
| Σ | 0..1 | Reference(Encounter) | Encounter motivating request | |
| Σ | 0..1 | Desired time or schedule for use | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| Σ | 0..1 | dateTime | When recorded | |
| Σ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Organization) | Who/what submitted the device request | |
| Σ | 0..1 | CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler | |
| Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Coded/Linked Reason for request Binding: Condition/Problem/Diagnosis Codes (Example) | |
| 0..1 | boolean | PRN status of request | ||
| 0..1 | CodeableConcept | Device usage reason | ||
| 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||
| 0..* | Reference(Any) | Additional clinical information | ||
| 0..* | Annotation | Notes or comments | ||
| 0..* | Reference(Provenance) | Request provenance | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Record of use of a device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External identifier for this record | |
| Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
| ?!Σ | 1..1 | code | active | completed | not-done | entered-in-error + Binding: Device Usage Status (Required) | |
| 0..* | CodeableConcept | The category of the statement - classifying how the statement is made | ||
| Σ | 1..1 | Reference(Patient) | Patient using device | |
| Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information | |
| Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | The encounter or episode of care that establishes the context for this device use statement | |
| Σ | 0..1 | How often the device was used | ||
| Timing | ||||
| Period | ||||
| dateTime | ||||
| Σ | 0..1 | dateTime | When the statement was made (and recorded) | |
| 0..1 | CodeableConcept | The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement Binding: Device Usage Status (Required) | ||
| 0..* | CodeableConcept | The reason for asserting the usage status - for example forgot, lost, stolen, broken | ||
| 0..1 | BackboneElement | How device is being used | ||
| 1..1 | CodeableConcept | always | never | sometimes Binding: Device Usage Adherence Code (Example) | ||
| 1..* | CodeableConcept | lost | stolen | prescribed | broken | burned | forgot Binding: Device Usage Adherence Reason (Example) | ||
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Who made the statement | |
| Σ | 1..1 | CodeableReference(Device | DeviceDefinition) | Code or Reference to device used | |
| Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | Procedure) | Why device was used | |
| Σ | 0..1 | CodeableReference(BodyStructure) | Target body site Binding: SNOMED CT Body Structures (Example) | |
| 0..* | Annotation | Addition details (comments, instructions) | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports + Rule: When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for report | |
| 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | ||
| ?!Σ | 1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: Diagnostic Report Status (Required) | |
| Σ | 0..* | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (Example) | |
| Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (Preferred) | |
| Σ | 0..1 | Reference(Patient | Group | Device | Location | Organization | Practitioner | Medication | Substance | BiologicallyDerivedProduct) | The subject of the report - usually, but not always, the patient | |
| Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | |
| Σ | 0..1 | Clinically relevant time/time-period for report | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | instant | DateTime this version was made | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | |
| 0..* | Reference(Specimen) | Specimens this report is based on | ||
| C | 0..* | Reference(Observation) | Observations | |
| 0..* | Annotation | Comments about the diagnostic report | ||
| 0..* | Reference(GenomicStudy | ImagingStudy) | Reference to full details of an analysis associated with the diagnostic report | ||
| 0..* | BackboneElement | Additional information supporting the diagnostic report | ||
| 1..1 | CodeableConcept | Supporting information role code Binding: hl7VS-VS-observationType (Example) | ||
| 1..1 | Reference(Procedure | Observation | DiagnosticReport | Citation) | Supporting information reference | ||
| Σ | 0..* | BackboneElement | Key images or data associated with this report | |
| 0..1 | string | Comment about the image or data (e.g. explanation) | ||
| Σ | 1..1 | Reference(DocumentReference) | Reference to the image or data source | |
| C | 0..1 | Reference(Composition) | Reference to a Composition resource for the DiagnosticReport structure | |
| 0..1 | markdown | Clinical conclusion (interpretation) of test results | ||
| 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMED CT Clinical Findings (Example) | ||
| 0..* | Attachment | Entire report as issued | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A reference to a document + Warning: facilityType SHALL only be present if context is not an encounter + Warning: practiceSetting SHALL only be present if context is not present Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifiers for the document | |
| Σ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | |
| 0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created | ||
| ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (Required) | |
| Σ | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: Composition Status (Required) | |
| Σ | 0..* | CodeableConcept | Imaging modality used Binding: Modality (Extensible) | |
| Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIR Document Type Codes (Preferred) | |
| Σ | 0..* | CodeableConcept | Categorization of document Binding: Referenced Item Category Value Set (Example) | |
| Σ | 0..1 | Reference(Any) | Who/what is the subject of the document | |
| C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | |
| 0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (Example) | ||
| Σ | 0..* | CodeableReference(BodyStructure) | Body part included Binding: SNOMED CT Body Structures (Example) | |
| C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type Code Value Set (Example) | |
| C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Code Value Set (Example) | |
| Σ | 0..1 | Period | Time of service that is being documented | |
| Σ | 0..1 | instant | When this document reference was created | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | |
| 0..* | BackboneElement | Attests to accuracy of the document | ||
| 1..1 | CodeableConcept | personal | professional | legal | official Binding: Composition Attestation Mode (Preferred) | ||
| 0..1 | dateTime | When the document was attested | ||
| 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | ||
| 0..1 | Reference(Organization) | Organization which maintains the document | ||
| Σ | 0..* | BackboneElement | Relationships to other documents | |
| Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: Document Relationship Type (Extensible) | |
| Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | |
| Σ | 0..1 | markdown | Human-readable description | |
| Σ | 0..* | CodeableConcept | Document security-tags Binding: Example set of Security Labels (Example) | |
| Σ | 1..* | BackboneElement | Document referenced | |
| Σ | 1..1 | Attachment | Where to access the document | |
| Σ | 0..* | BackboneElement | Content profile rules for the document | |
| Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (Preferred) | ||
| Coding | ||||
| uri | ||||
| canonical() | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| «A»N | Resource | A resource with narrative, extensions, and contained resources + Rule: If the resource is contained in another resource, it SHALL NOT contain nested Resources + Rule: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource + Rule: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated + Rule: If a resource is contained in another resource, it SHALL NOT have a security label + Guideline: A resource should have narrative for robust management Elements defined in Ancestors: id, meta, implicitRules, language | ||
| C | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| C | 0..* | Resource | Contained, inline Resources | |
| 0..* | Extension | Additional content defined by implementations | ||
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An interaction during which services are provided to the patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | |
| ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: Encounter Status (Required) | |
| Σ | 0..* | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (Preferred) | |
| 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (Example) | ||
| Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: Encounter Type (Example) | |
| Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: Service Type (Example) | |
| Σ | 0..1 | Reference(Patient | Group) | The patient or group related to this encounter | |
| 0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: Encounter Subject Status (Example) | ||
| Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
| 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request that initiated this encounter | ||
| 0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | ||
| 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | ||
| 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | ||
| ΣC | 0..* | BackboneElement | List of participants involved in the encounter + Rule: A type must be provided when no explicit actor is specified + Rule: A type cannot be provided for a patient or group participant | |
| ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: Participant Type (Extensible) | |
| 0..1 | Period | Period of time during the encounter that the participant participated | ||
| ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | |
| Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | |
| 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | ||
| 0..1 | Period | The actual start and end time of the encounter | ||
| 0..1 | dateTime | The planned start date/time (or admission date) of the encounter | ||
| 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | ||
| 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | ||
| Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | |
| Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: Encounter Reason Use (Example) | |
| Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) | Reason the encounter takes place (core or reference) Binding: Encounter Reason Codes (Preferred) | |
| Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: Condition/Problem/Diagnosis Codes (Example) | |
| 0..* | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: Encounter Diagnosis Use (Preferred) | ||
| 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | ||
| 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (Example) | ||
| 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: Special Arrangements (Preferred) | ||
| 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: Special Courtesy (Preferred) | ||
| 0..1 | BackboneElement | Details about the admission to a healthcare service | ||
| 0..1 | Identifier | Pre-admission identifier | ||
| 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | ||
| 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: Admit Source (Preferred) | ||
| 0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (Example) | ||
| 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | ||
| 0..1 | CodeableConcept | Category or kind of location after discharge Binding: Discharge Disposition (Example) | ||
| 0..* | BackboneElement | List of locations where the patient has been | ||
| 1..1 | Reference(Location) | Location the encounter takes place | ||
| 0..1 | code | planned | active | reserved | completed Binding: Encounter Location Status (Required) | ||
| 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: Location Form (Example) | ||
| 0..1 | Period | Time period during which the patient was present at the location | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A record of significant events/milestones key data throughout the history of an Encounter Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..1 | Reference(Encounter) | The Encounter associated with this set of historic values | ||
| Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | |
| ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: Encounter Status (Required) | |
| Σ | 1..1 | CodeableConcept | Classification of patient encounter Binding: ActEncounterCode (Extensible) | |
| Σ | 0..* | CodeableConcept | Specific type of encounter Binding: Encounter Type (Example) | |
| Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: Service Type (Example) | |
| Σ | 0..1 | Reference(Patient | Group) | The patient or group related to this encounter | |
| 0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: Encounter Subject Status (Example) | ||
| 0..1 | Period | The actual start and end time associated with this set of values associated with the encounter | ||
| 0..1 | dateTime | The planned start date/time (or admission date) of the encounter | ||
| 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | ||
| 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | ||
| 0..* | BackboneElement | Location of the patient at this point in the encounter | ||
| 1..1 | Reference(Location) | Location the encounter takes place | ||
| 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: Location Form (Example) | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | The technical details of an endpoint that can be used for electronic services Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifies this endpoint across multiple systems | |
| ?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: Endpoint Status (Required) | |
| Σ | 1..* | CodeableConcept | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (Example) | |
| Σ | 0..1 | string | A name that this endpoint can be identified by | |
| Σ | 0..1 | string | Additional details about the endpoint that could be displayed as further information to identify the description beyond its name | |
| Σ | 0..* | CodeableConcept | The type of environment(s) exposed at this endpoint Binding: Endpoint Environment (Extensible) | |
| Σ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
| 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||
| Σ | 0..1 | Period | Interval the endpoint is expected to be operational | |
| 0..* | BackboneElement | Set of payloads that are provided by this endpoint | ||
| Σ | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type (Example) | |
| Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (Required) | |
| Σ | 1..1 | url | The technical base address for connecting to this endpoint | |
| 0..* | string | Usage depends on the channel type | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Enroll in coverage Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier | ||
| ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| 0..1 | dateTime | Creation date | ||
| 0..1 | Reference(Organization) | Target | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | ||
| 0..1 | Reference(Patient) | The subject to be enrolled | ||
| 0..1 | Reference(Coverage) | Insurance information | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | EnrollmentResponse resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier | ||
| ?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| 0..1 | Reference(EnrollmentRequest) | Claim reference | ||
| 0..1 | code | queued | complete | error | partial Binding: Enrollment Outcome (Required) | ||
| 0..1 | string | Disposition Message | ||
| 0..1 | dateTime | Creation date | ||
| 0..1 | Reference(Organization) | Insurer | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | ||
| ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Episode Of Care Status (Required) | |
| 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | ||
| 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Episode Of Care Status (Required) | ||
| 1..1 | Period | Duration the EpisodeOfCare was in the specified status | ||
| Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: Episode Of Care Type (Example) | |
| Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | |
| Σ | 0..1 | CodeableConcept | What the reason value should be used for/as Binding: Encounter Reason Use (Example) | |
| Σ | 0..* | CodeableReference(Condition | Procedure | Observation | HealthcareService) | Medical reason to be addressed Binding: Encounter Reason Codes (Example) | |
| Σ | 0..* | BackboneElement | The list of medical conditions that were addressed during the episode of care | |
| Σ | 0..* | CodeableReference(Condition) | The medical condition that was addressed during the episode of care Binding: Condition/Problem/Diagnosis Codes (Example) | |
| Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: Encounter Diagnosis Use (Preferred) | |
| Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | |
| Σ | 0..1 | Reference(Organization) | Organization that assumes responsibility for care coordination | |
| Σ | 0..1 | Period | Interval during responsibility is assumed | |
| 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | ||
| 0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | ||
| 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A description of when an event can occur + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this event definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the event definition | |
| Σ | 0..1 | string | Business version of the event definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this event definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this event definition (human friendly) | |
| 0..1 | string | Subordinate title of the event definition | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| 0..1 | Type of individual the event definition is focused on Binding: Participant Resource Types (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the event definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for event definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this event definition is defined | |
| 0..1 | markdown | Describes the clinical usage of the event definition | ||
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| Σ | 0..1 | date | When the event definition was approved by publisher | |
| Σ | 0..1 | date | When the event definition was last reviewed by the publisher | |
| Σ | 0..1 | Period | When the event definition is expected to be used | |
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the content | ||
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| 0..* | ContactDetail | Who endorsed the content | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| Σ | 1..* | TriggerDefinition | "when" the event occurs (multiple = 'or') | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Single evidence bit + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this evidence, represented as a globally unique URI + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the summary | |
| Σ | 0..1 | string | Business version of this summary | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| C | 0..1 | string | Name for this summary (machine friendly) | |
| ΣT | 0..1 | string | Name for this summary (human friendly) | |
| 0..1 | Citation for this evidence | |||
| Reference(Citation) | ||||
| markdown | ||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| 0..1 | boolean | For testing purposes, not real usage | ||
| Σ | 0..1 | dateTime | Date last changed | |
| 0..1 | date | When the summary was approved by publisher | ||
| 0..1 | date | When the summary was last reviewed by the publisher | ||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..* | ContactDetail | Who authored the content | |
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| Σ | 0..* | ContactDetail | Who endorsed the content | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| 0..1 | markdown | Why this Evidence is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..* | RelatedArtifact | Link or citation to artifact associated with the summary | ||
| T | 0..1 | markdown | Description of the particular summary | |
| T | 0..1 | markdown | Declarative description of the Evidence | |
| 0..* | Annotation | Footnotes and/or explanatory notes | ||
| 1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | ||
| 0..1 | markdown | A text description or summary of the variable | ||
| 0..* | Annotation | Footnotes and/or explanatory notes | ||
| Σ | 1..1 | CodeableConcept | population | subpopulation | exposure | referenceExposure | measuredVariable | confounder Binding: Evidence Variable Role (Extensible) | |
| Σ | 0..1 | Reference(Group | EvidenceVariable) | Definition of the actual variable related to the statistic(s) | |
| 0..1 | Reference(Group | EvidenceVariable) | Definition of the intended variable related to the Evidence | ||
| 0..1 | CodeableConcept | low | moderate | high | exact Binding: EvidenceDirectness (Extensible) | ||
| 0..1 | CodeableConcept | The method to combine studies Binding: StatisticSynthesisType (Extensible) | ||
| 0..* | CodeableConcept | The design of the study that produced this evidence Binding: Study Design (Extensible) | ||
| 0..* | BackboneElement | Values and parameters for a single statistic | ||
| 0..1 | markdown | Description of content | ||
| 0..* | Annotation | Footnotes and/or explanatory notes | ||
| 0..1 | CodeableConcept | Type of statistic, e.g., relative risk Binding: Statistic Type (Extensible) | ||
| 0..1 | CodeableConcept | Associated category for categorical variable | ||
| 0..1 | Quantity | Statistic value | ||
| 0..1 | unsignedInt | The number of events associated with the statistic | ||
| 0..1 | unsignedInt | The number of participants affected | ||
| 0..1 | BackboneElement | Number of samples in the statistic | ||
| 0..1 | markdown | Textual description of sample size for statistic | ||
| 0..* | Annotation | Footnote or explanatory note about the sample size | ||
| 0..1 | unsignedInt | Number of contributing studies | ||
| 0..1 | unsignedInt | Cumulative number of participants | ||
| 0..1 | unsignedInt | Number of participants with known results for measured variables | ||
| 0..* | BackboneElement | An attribute of the Statistic | ||
| 0..1 | markdown | Textual description of the attribute estimate | ||
| 0..* | Annotation | Footnote or explanatory note about the estimate | ||
| 0..1 | CodeableConcept | The type of attribute estimate, e.g., confidence interval or p value Binding: Attribute Estimate Type (Extensible) | ||
| 0..1 | Quantity | The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure | ||
| 0..1 | decimal | Level of confidence interval, e.g., 0.95 for 95% confidence interval | ||
| 0..1 | Range | Lower and upper bound values of the attribute estimate | ||
| 0..* | see attributeEstimate | A nested attribute estimate; which is the attribute estimate of an attribute estimate | ||
| 0..* | BackboneElement | An aspect of the statistical model | ||
| 1..1 | CodeableConcept | Model specification Binding: Statistic Model Code (Extensible) | ||
| 0..1 | SimpleQuantity | Numerical value to complete model specification | ||
| 0..* | BackboneElement | A variable adjusted for in the adjusted analysis | ||
| 1..1 | Reference(Group | EvidenceVariable) | Description of the variable | ||
| 0..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: Evidence Variable Handling (Required) | ||
| 0..* | CodeableConcept | Description for grouping of ordinal or polychotomous variables | ||
| 0..* | Quantity | Discrete value for grouping of ordinal or polychotomous variables | ||
| 0..* | Range | Range of values for grouping of ordinal or polychotomous variables | ||
| 0..* | see attributeEstimate | An attribute of the statistic used as a model characteristic | ||
| 0..* | BackboneElement | Certainty or quality of the evidence | ||
| 0..1 | markdown | Textual description of certainty | ||
| 0..* | Annotation | Footnotes and/or explanatory notes | ||
| 0..1 | CodeableConcept | Aspect of certainty being rated Binding: Evidence Certainty Type (Extensible) | ||
| 0..1 | CodeableConcept | Assessment or judgement of the aspect Binding: Evidence Certainty Rating (Extensible) | ||
| 0..1 | string | Individual or group who did the rating | ||
| 0..* | see certainty | A domain or subdomain of certainty | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A EvidenceReport Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this EvidenceReport, represented as a globally unique URI + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | Identifier | Unique identifier for the evidence report | |
| Σ | 0..* | Identifier | Identifiers for articles that may relate to more than one evidence report | |
| 0..1 | Citation for this report | |||
| Reference(Citation) | ||||
| markdown | ||||
| 0..1 | CodeableConcept | Kind of report Binding: Evidence Report Type (Example) | ||
| 0..* | Annotation | Used for footnotes and annotations | ||
| 0..* | RelatedArtifact | Link, description or reference to artifact associated with the report | ||
| Σ | 1..1 | BackboneElement | Focus of the report | |
| 0..* | BackboneElement | Characteristic | ||
| 1..1 | CodeableConcept | Characteristic code Binding: Focus Characteristic Code (Extensible) | ||
| 1..1 | Characteristic value | |||
| Reference(Any) | ||||
| CodeableConcept | ||||
| boolean | ||||
| Quantity | ||||
| Range | ||||
| 0..1 | boolean | Is used to express not the characteristic | ||
| 0..1 | Period | Timeframe for the characteristic | ||
| 0..* | Annotation | Footnotes and/or explanatory notes | ||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..* | ContactDetail | Who authored the content | |
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| Σ | 0..* | ContactDetail | Who endorsed the content | |
| 0..* | BackboneElement | Relationships to other compositions/documents | ||
| 1..1 | code | replaces | amends | appends | transforms | replacedWith | amendedWith | appendedWith | transformedWith Binding: Report Relationship Type (Required) | ||
| 1..1 | BackboneElement | Target of the relationship | ||
| 0..1 | uri | Target of the relationship URL | ||
| 0..1 | Identifier | Target of the relationship Identifier | ||
| 0..1 | markdown | Target of the relationship Display | ||
| 0..1 | Reference(Any) | Target of the relationship Resource reference | ||
| 0..* | BackboneElement | Composition is broken into sections | ||
| T | 0..1 | string | Label for section (e.g. for ToC) | |
| 0..1 | CodeableConcept | Classification of section (recommended) Binding: Report Section Type (Extensible) | ||
| 0..1 | Reference(Any) | Classification of section by Resource | ||
| 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | Group | Organization) | Who and/or what authored the section | ||
| 0..1 | Narrative | Text summary of the section, for human interpretation | ||
| 0..1 | code | working | snapshot | changes Binding: List Mode (Required) | ||
| 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (Preferred) | ||
| 0..* | CodeableConcept | Extensible classifiers as content Binding: Evidence Classifier (Extensible) | ||
| 0..* | Reference(Any) | Reference to resources as content | ||
| 0..* | Quantity | Quantity as content | ||
| 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (Preferred) | ||
| 0..* | see section | Nested Section | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A definition of an exposure, outcome, or other variable + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the evidence variable | |
| Σ | 0..1 | string | Business version of the evidence variable | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this evidence variable (computer friendly) | |
| Σ | 0..1 | string | Name for this evidence variable (human friendly) | |
| Σ | 0..1 | string | Title for use in informal contexts | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| 0..1 | boolean | For testing purposes, not real usage | ||
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..1 | markdown | Natural language description of the evidence variable | |
| 0..* | Annotation | Used for footnotes or explanatory notes | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| 0..1 | markdown | Why this EvidenceVariable is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the resource was approved by publisher | ||
| 0..1 | date | When the resource was last reviewed by the publisher | ||
| 0..1 | Period | When the resource is expected to be used | ||
| 0..* | ContactDetail | Who authored the content | ||
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| 0..* | ContactDetail | Who endorsed the content | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| 0..1 | boolean | Actual or conceptual | ||
| ΣC | 0..* | BackboneElement | A defining factor of the EvidenceVariable + Rule: In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination | |
| 0..1 | id | Label for internal linking | ||
| 0..1 | markdown | Natural language description of the characteristic | ||
| 0..* | Annotation | Used for footnotes or explanatory notes | ||
| 0..1 | boolean | Whether the characteristic is an inclusion criterion or exclusion criterion | ||
| ΣC | 0..1 | Reference(EvidenceVariable | Group | Evidence) | Defines the characteristic (without using type and value) by a Reference | |
| ΣC | 0..1 | canonical(EvidenceVariable | Evidence) | Defines the characteristic (without using type and value) by a Canonical | |
| ΣC | 0..1 | CodeableConcept | Defines the characteristic (without using type and value) by a CodeableConcept | |
| Σ | 0..1 | Expression | Defines the characteristic (without using type and value) by an expression | |
| ΣC | 0..1 | id | Defines the characteristic (without using type and value) by an id | |
| ΣC | 0..1 | BackboneElement | Defines the characteristic using type and value | |
| Σ | 1..1 | CodeableConcept | Expresses the type of characteristic Binding: UsageContextType (Example) | |
| 0..* | CodeableConcept | Method for how the characteristic value was determined Binding: Definition Method (Example) | ||
| 0..1 | Reference(Device | DeviceMetric) | Device used for determining characteristic | ||
| Σ | 1..1 | Defines the characteristic when coupled with characteristic.type | ||
| CodeableConcept | ||||
| boolean | ||||
| Quantity | ||||
| Range | ||||
| Reference() | ||||
| id | ||||
| 0..1 | CodeableConcept | Reference point for valueQuantity or valueRange Binding: Characteristic Offset (Example) | ||
| C | 0..1 | BackboneElement | Used to specify how two or more characteristics are combined | |
| 1..1 | code | all-of | any-of | at-least | at-most | statistical | net-effect | dataset Binding: Characteristic Combination (Required) | ||
| 0..1 | positiveInt | Provides the value of "n" when "at-least" or "at-most" codes are used | ||
| 1..* | see characteristic | A defining factor of the characteristic | ||
| 0..1 | Number of occurrences meeting the characteristic | |||
| Quantity | ||||
| Range | ||||
| 0..1 | Length of time in which the characteristic is met | |||
| Quantity | ||||
| Range | ||||
| 0..* | BackboneElement | Timing in which the characteristic is determined | ||
| 0..1 | markdown | Human readable description | ||
| 0..* | Annotation | Used for footnotes or explanatory notes | ||
| 0..1 | The event used as a base point (reference point) in time Binding: Evidence Variable Event (Example) | |||
| CodeableConcept | ||||
| Reference() | ||||
| dateTime | ||||
| id | ||||
| 0..1 | Quantity | Used to express the observation at a defined amount of time before or after the event | ||
| 0..1 | Range | Used to express the observation within a period before and/or after the event | ||
| 0..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: Evidence Variable Handling (Required) | ||
| 0..* | BackboneElement | A grouping for ordinal or polychotomous variables | ||
| 0..1 | string | Description of the grouping | ||
| 0..1 | Definition of the grouping | |||
| CodeableConcept | ||||
| Quantity | ||||
| Range | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Example of workflow instance + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Must have actors if status is active or required + Rule: Must have processes if status is active or required + Rule: Actor keys must be unique + Rule: Actor titles must be unique + Rule: Instance keys must be unique + Rule: Instance titles must be unique + Rule: Process titles must be unique Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this example scenario, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the example scenario | |
| Σ | 0..1 | string | Business version of the example scenario | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | To be removed? | |
| ΣT | 0..1 | string | Name for this example scenario (human friendly) | |
| ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the ExampleScenario | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for example scenario (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | The purpose of the example, e.g. to illustrate a scenario | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| T | 0..1 | string | Copyright holder and year(s) | |
| C | 0..* | BackboneElement | Individual involved in exchange + Warning: Actor should be referenced in at least one operation + Rule: actor.key canot be 'OTHER' | |
| C | 1..1 | string | ID or acronym of the actor | |
| 1..1 | code | person | system Binding: Example Scenario Actor Type (Required) | ||
| TC | 1..1 | string | Label for actor when rendering | |
| T | 0..1 | markdown | Details about actor | |
| C | 0..* | BackboneElement | Data used in the scenario + Rule: StructureVersion is required if structureType is not FHIR (but may still be present even if FHIR) + Rule: instance.content is only allowed if there are no instance.versions + Rule: Version keys must be unique within an instance + Rule: Version titles must be unique within an instance + Warning: Instance should be referenced in at least one location + Warning: Instance version should be referenced in at least one operation | |
| C | 1..1 | string | ID or acronym of the instance | |
| C | 1..1 | Coding | Data structure for example Binding: Example Scenario Resource Type (Extensible) | |
| C | 0..1 | string | E.g. 4.0.1 | |
| 0..1 | Rules instance adheres to | |||
| canonical() | ||||
| uri | ||||
| TC | 1..1 | string | Label for instance | |
| T | 0..1 | markdown | Human-friendly description of the instance | |
| C | 0..1 | Reference() | Example instance data | |
| C | 0..* | BackboneElement | Snapshot of instance that changes | |
| C | 1..1 | string | ID or acronym of the version | |
| C | 1..1 | string | Label for instance version | |
| T | 0..1 | markdown | Details about version | |
| 0..1 | Reference() | Example instance version data | ||
| C | 0..* | BackboneElement | Resources contained in the instance + Rule: InstanceReference must be a key of an instance defined in the ExampleScenario + Rule: versionReference must be specified if the referenced instance defines versions + Rule: versionReference must be a key of a version within the instance pointed to by instanceReference | |
| C | 1..1 | string | Key of contained instance | |
| C | 0..1 | string | Key of contained instance version | |
| C | 0..* | BackboneElement | Major process within scenario + Rule: Processes must have steps if ExampleScenario status is active or required | |
| ΣTC | 1..1 | string | Label for procss | |
| T | 0..1 | markdown | Human-friendly description of the process | |
| T | 0..1 | markdown | Status before process starts | |
| T | 0..1 | markdown | Status after successful completion | |
| C | 0..* | BackboneElement | Event within of the process + Rule: Alternative titles must be unique within a step + Rule: Can have a process, a workflow, one or more operations or none of these, but cannot have a combination | |
| 0..1 | string | Sequential number of the step | ||
| 0..1 | see process | Step is nested process | ||
| C | 0..1 | canonical(ExampleScenario) | Step is nested workflow | |
| C | 0..1 | BackboneElement | Step is simple action + Rule: If specified, initiator must be a key of an actor within the ExampleScenario + Rule: If specified, receiver must be a key of an actor within the ExampleScenario | |
| 0..1 | Coding | Kind of action Binding: Test Script Operation Code (Extensible) | ||
| 1..1 | string | Label for step | ||
| C | 0..1 | string | Who starts the operation | |
| C | 0..1 | string | Who receives the operation | |
| T | 0..1 | markdown | Human-friendly description of the operation | |
| 0..1 | boolean | Initiator stays active? | ||
| 0..1 | boolean | Receiver stays active? | ||
| 0..1 | see containedInstance | Instance transmitted on invocation | ||
| 0..1 | see containedInstance | Instance transmitted on invocation response | ||
| C | 0..* | BackboneElement | Alternate non-typical step action | |
| TC | 1..1 | string | Label for alternative | |
| T | 0..1 | markdown | Human-readable description of option | |
| 0..* | see step | Alternative action(s) | ||
| 0..1 | boolean | Pause in the flow? | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | Explanation of Benefit resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| 0..* | Identifier | Business Identifier for the resource | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Explanation Of Benefit Status (Required) | |||||
| Σ | 1..1 | CodeableConcept | Category or discipline Binding: Claim Type Codes (Extensible) | |||||
| 0..1 | CodeableConcept | More granular claim type Binding: Example Claim SubType Codes (Example) | ||||||
| Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (Required) | |||||
| Σ | 1..1 | Reference(Patient) | The recipient of the products and services | |||||
| Σ | 0..1 | Period | Relevant time frame for the claim | |||||
| Σ | 1..1 | dateTime | Response creation date | |||||
| 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Author of the claim | ||||||
| Σ | 0..1 | Reference(Organization) | Party responsible for reimbursement | |||||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim | |||||
| 0..1 | CodeableConcept | Desired processing urgency Binding: Process Priority Codes (Example) | ||||||
| 0..1 | CodeableConcept | For whom to reserve funds Binding: Funds Reservation Codes (Example) | ||||||
| 0..1 | CodeableConcept | Funds reserved status Binding: Funds Reservation Codes (Example) | ||||||
| 0..* | BackboneElement | Prior or corollary claims | ||||||
| 0..1 | Reference(Claim) | Reference to the related claim | ||||||
| 0..1 | CodeableConcept | How the reference claim is related Binding: Example Related Claim Relationship Codes (Example) | ||||||
| 0..1 | Identifier | File or case reference | ||||||
| 0..1 | Reference(MedicationRequest | VisionPrescription) | Prescription authorizing services or products | ||||||
| 0..1 | Reference(MedicationRequest) | Original prescription if superceded by fulfiller | ||||||
| 0..* | BackboneElement | Event information | ||||||
| 1..1 | CodeableConcept | Specific event Binding: Dates Type Codes (Example) | ||||||
| 1..1 | Occurance date or period | |||||||
| dateTime | ||||||||
| Period | ||||||||
| 0..1 | BackboneElement | Recipient of benefits payable | ||||||
| 0..1 | CodeableConcept | Category of recipient Binding: Claim Payee Type Codes (Example) | ||||||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | ||||||
| 0..1 | Reference(ServiceRequest) | Treatment Referral | ||||||
| 0..* | Reference(Encounter) | Encounters associated with the listed treatments | ||||||
| 0..1 | Reference(Location | Organization) | Servicing Facility | ||||||
| 0..1 | Reference(Claim) | Claim reference | ||||||
| 0..1 | Reference(ClaimResponse) | Claim response reference | ||||||
| Σ | 1..1 | code | queued | complete | error | partial Binding: Claim Processing Codes (Required) | |||||
| Σ | 0..1 | CodeableConcept | Result of the adjudication Binding: Claim Adjudication Decision Codes (Example) | |||||
| 0..1 | string | Disposition Message | ||||||
| 0..* | string | Preauthorization reference | ||||||
| 0..* | Period | Preauthorization in-effect period | ||||||
| 0..1 | CodeableConcept | Package billing code Binding: Example Diagnosis Related Group Codes (Example) | ||||||
| 0..* | BackboneElement | Care Team members | ||||||
| 1..1 | positiveInt | Order of care team | ||||||
| 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Practitioner or organization | ||||||
| 0..1 | boolean | Indicator of the lead practitioner | ||||||
| 0..1 | CodeableConcept | Function within the team Binding: Claim Care Team Role Codes (Example) | ||||||
| 0..1 | CodeableConcept | Practitioner or provider specialization Binding: Example Provider Qualification Codes (Example) | ||||||
| 0..* | BackboneElement | Supporting information | ||||||
| 1..1 | positiveInt | Information instance identifier | ||||||
| 1..1 | CodeableConcept | Classification of the supplied information Binding: Claim Information Category Codes (Example) | ||||||
| 0..1 | CodeableConcept | Type of information Binding: Exception Codes (Example) | ||||||
| 0..1 | When it occurred | |||||||
| date | ||||||||
| Period | ||||||||
| 0..1 | Data to be provided | |||||||
| boolean | ||||||||
| string | ||||||||
| Quantity | ||||||||
| Attachment | ||||||||
| Reference(Any) | ||||||||
| Identifier | ||||||||
| 0..1 | Coding | Explanation for the information Binding: Missing Tooth Reason Codes (Example) | ||||||
| 0..* | BackboneElement | Pertinent diagnosis information | ||||||
| 1..1 | positiveInt | Diagnosis instance identifier | ||||||
| 1..1 | Nature of illness or problem Binding: ICD-10 Codes (Example) | |||||||
| CodeableConcept | ||||||||
| Reference(Condition) | ||||||||
| 0..* | CodeableConcept | Timing or nature of the diagnosis Binding: Example Diagnosis Type Codes (Example) | ||||||
| 0..1 | CodeableConcept | Present on admission Binding: Example Diagnosis on Admission Codes (Example) | ||||||
| 0..* | BackboneElement | Clinical procedures performed | ||||||
| 1..1 | positiveInt | Procedure instance identifier | ||||||
| 0..* | CodeableConcept | Category of Procedure Binding: Example Procedure Type Codes (Example) | ||||||
| 0..1 | dateTime | When the procedure was performed | ||||||
| 1..1 | Specific clinical procedure Binding: ICD-10 Procedure Codes (Example) | |||||||
| CodeableConcept | ||||||||
| Reference(Procedure) | ||||||||
| 0..* | Reference(Device) | Unique device identifier | ||||||
| 0..1 | positiveInt | Precedence (primary, secondary, etc.) | ||||||
| Σ | 0..* | BackboneElement | Patient insurance information | |||||
| Σ | 1..1 | boolean | Coverage to be used for adjudication | |||||
| Σ | 1..1 | Reference(Coverage) | Insurance information | |||||
| 0..* | string | Prior authorization reference number | ||||||
| 0..1 | BackboneElement | Details of the event | ||||||
| 0..1 | date | When the incident occurred | ||||||
| 0..1 | CodeableConcept | The nature of the accident Binding: ActIncidentCode (Extensible) | ||||||
| 0..1 | Where the event occurred | |||||||
| Address | ||||||||
| Reference(Location) | ||||||||
| 0..1 | Money | Paid by the patient | ||||||
| 0..* | BackboneElement | Product or service provided | ||||||
| 1..1 | positiveInt | Item instance identifier | ||||||
| 0..* | positiveInt | Applicable care team members | ||||||
| 0..* | positiveInt | Applicable diagnoses | ||||||
| 0..* | positiveInt | Applicable procedures | ||||||
| 0..* | positiveInt | Applicable exception and supporting information | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | Reference(DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription) | Request or Referral for Service | ||||||
| 0..* | CodeableConcept | Product or service billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||||||
| 0..1 | Date or dates of service or product delivery | |||||||
| date | ||||||||
| Period | ||||||||
| 0..1 | Place of service or where product was supplied Binding: Example Service Place Codes (Example) | |||||||
| CodeableConcept | ||||||||
| Address | ||||||||
| Reference(Location) | ||||||||
| 0..1 | Money | Paid by the patient | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | Reference(Device) | Unique device identifier | ||||||
| 0..* | BackboneElement | Anatomical location | ||||||
| 1..* | CodeableReference(BodyStructure) | Location Binding: Oral Site Codes (Example) | ||||||
| 0..* | CodeableConcept | Sub-location Binding: Surface Codes (Example) | ||||||
| 0..* | Reference(Encounter) | Encounters associated with the listed treatments | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | BackboneElement | Adjudication results | ||||||
| 0..1 | CodeableConcept | Result of the adjudication Binding: Claim Adjudication Decision Codes (Example) | ||||||
| 0..* | CodeableConcept | Reason for result of the adjudication Binding: Claim Adjudication Decision Reason Codes (Example) | ||||||
| 0..1 | string | Preauthorization reference | ||||||
| 0..1 | Period | Preauthorization reference effective period | ||||||
| 0..* | BackboneElement | Adjudication details | ||||||
| 1..1 | CodeableConcept | Type of adjudication information Binding: Adjudication Value Codes (Example) | ||||||
| 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: Adjudication Reason Codes (Example) | ||||||
| 0..1 | Money | Monetary amount | ||||||
| 0..1 | Quantity | Non-monitary value | ||||||
| 0..* | BackboneElement | Additional items | ||||||
| 1..1 | positiveInt | Product or service provided | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||||||
| 0..1 | Money | Paid by the patient | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | Reference(Device) | Unique device identifier | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Detail level adjudication results | ||||||
| 0..* | see adjudication | Detail level adjudication details | ||||||
| 0..* | BackboneElement | Additional items | ||||||
| 1..1 | positiveInt | Product or service provided | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||||||
| 0..1 | Money | Paid by the patient | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | Reference(Device) | Unique device identifier | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Subdetail level adjudication results | ||||||
| 0..* | see adjudication | Subdetail level adjudication details | ||||||
| 0..* | BackboneElement | Insurer added line items | ||||||
| 0..* | positiveInt | Item sequence number | ||||||
| 0..* | positiveInt | Detail sequence number | ||||||
| 0..* | positiveInt | Subdetail sequence number | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | Reference(DeviceRequest | MedicationRequest | NutritionOrder | ServiceRequest | SupplyRequest | VisionPrescription) | Request or Referral for Service | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..* | CodeableConcept | Program the product or service is provided under Binding: Example Program Reason Codes (Example) | ||||||
| 0..1 | Date or dates of service or product delivery | |||||||
| date | ||||||||
| Period | ||||||||
| 0..1 | Place of service or where product was supplied Binding: Example Service Place Codes (Example) | |||||||
| CodeableConcept | ||||||||
| Address | ||||||||
| Reference(Location) | ||||||||
| 0..1 | Money | Paid by the patient | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | BackboneElement | Anatomical location | ||||||
| 1..* | CodeableReference(BodyStructure) | Location Binding: Oral Site Codes (Example) | ||||||
| 0..* | CodeableConcept | Sub-location Binding: Surface Codes (Example) | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Additem level adjudication results | ||||||
| 0..* | see adjudication | Added items adjudication | ||||||
| 0..* | BackboneElement | Insurer added line items | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..1 | Money | Paid by the patient | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Additem detail level adjudication results | ||||||
| 0..* | see adjudication | Added items adjudication | ||||||
| 0..* | BackboneElement | Insurer added line items | ||||||
| 0..* | Identifier | Number for tracking | ||||||
| 0..1 | CodeableConcept | Revenue or cost center code Binding: Example Revenue Center Codes (Example) | ||||||
| 0..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLS Codes (Example) | ||||||
| 0..1 | CodeableConcept | End of a range of codes Binding: USCLS Codes (Example) | ||||||
| 0..* | CodeableConcept | Service/Product billing modifiers Binding: Modifier type Codes (Example) | ||||||
| 0..1 | Money | Paid by the patient | ||||||
| 0..1 | SimpleQuantity | Count of products or services | ||||||
| 0..1 | Money | Fee, charge or cost per item | ||||||
| 0..1 | decimal | Price scaling factor | ||||||
| 0..1 | Money | Total tax | ||||||
| 0..1 | Money | Total item cost | ||||||
| 0..* | positiveInt | Applicable note numbers | ||||||
| 0..1 | see reviewOutcome | Additem subdetail level adjudication results | ||||||
| 0..* | see adjudication | Added items adjudication | ||||||
| 0..* | see adjudication | Header-level adjudication | ||||||
| Σ | 0..* | BackboneElement | Adjudication totals | |||||
| Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: Adjudication Value Codes (Example) | |||||
| Σ | 1..1 | Money | Financial total for the category | |||||
| 0..1 | BackboneElement | Payment Details | ||||||
| 0..1 | CodeableConcept | Partial or complete payment Binding: Example Payment Type Codes (Example) | ||||||
| 0..1 | Money | Payment adjustment for non-claim issues | ||||||
| 0..1 | CodeableConcept | Explanation for the variance Binding: Payment Adjustment Reason Codes (Example) | ||||||
| 0..1 | date | Expected date of payment | ||||||
| 0..1 | Money | Payable amount after adjustment | ||||||
| 0..1 | Identifier | Business identifier for the payment | ||||||
| 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (Example) | ||||||
| 0..1 | Attachment | Printed reference or actual form | ||||||
| 0..* | BackboneElement | Note concerning adjudication | ||||||
| 0..1 | positiveInt | Note instance identifier | ||||||
| 0..1 | CodeableConcept | Note purpose Binding: NoteType (Extensible) | ||||||
| 0..1 | string | Note explanatory text | ||||||
| 0..1 | CodeableConcept | Language of the text Binding: All Languages (Required)
| ||||||
| 0..1 | Period | When the benefits are applicable | ||||||
| 0..* | BackboneElement | Balance by Benefit Category | ||||||
| 1..1 | CodeableConcept | Benefit classification Binding: Benefit Category Codes (Example) | ||||||
| 0..1 | boolean | Excluded from the plan | ||||||
| 0..1 | string | Short name for the benefit | ||||||
| 0..1 | string | Description of the benefit or services covered | ||||||
| 0..1 | CodeableConcept | In or out of network Binding: Network Type Codes (Example) | ||||||
| 0..1 | CodeableConcept | Individual or family Binding: Unit Type Codes (Example) | ||||||
| 0..1 | CodeableConcept | Annual or lifetime Binding: Benefit Term Codes (Example) | ||||||
| 0..* | BackboneElement | Benefit Summary | ||||||
| 1..1 | CodeableConcept | Benefit classification Binding: Benefit Type Codes (Example) | ||||||
| 0..1 | Benefits allowed | |||||||
| unsignedInt | ||||||||
| string | ||||||||
| Money | ||||||||
| 0..1 | Benefits used | |||||||
| unsignedInt | ||||||||
| Money | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Information about patient's relatives, relevant for patient + Rule: Can have age[x] or born[x], but not both + Rule: Can only have estimatedAge if age[x] is present + Rule: Can have age[x] or deceased[x], but not both Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Id(s) for this record | |
| Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: Family History Status (Required) | |
| Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: Family History Absent Reason (Example) | |
| Σ | 1..1 | Reference(Patient) | Patient history is about | |
| Σ | 0..1 | dateTime | When history was recorded or last updated | |
| Σ | 0..* | BackboneElement | Who or what participated in the activities related to the family member history and how they were involved | |
| Σ | 0..1 | CodeableConcept | Type of involvement Binding: Participation Role Type (Extensible) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) | Who or what participated in the activities related to the family member history | |
| Σ | 0..1 | string | The family member described | |
| Σ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (Example) | |
| Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (Extensible) | |
| C | 0..1 | (approximate) date of birth | ||
| Period | ||||
| date | ||||
| string | ||||
| ΣC | 0..1 | (approximate) age | ||
| Age | ||||
| Range | ||||
| string | ||||
| ΣC | 0..1 | boolean | Age is estimated? | |
| ΣC | 0..1 | Dead? How old/when? | ||
| boolean | ||||
| Age | ||||
| Range | ||||
| date | ||||
| string | ||||
| Σ | 0..* | CodeableReference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? Binding: SNOMED CT Clinical Findings (Example) | |
| 0..* | Annotation | General note about related person | ||
| 0..* | BackboneElement | Condition that the related person had | ||
| 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/Diagnosis Codes (Example) | ||
| 0..1 | CodeableConcept | deceased | permanent disability | etc Binding: Condition Outcome Codes (Example) | ||
| 0..1 | boolean | Whether the condition contributed to the cause of death | ||
| 0..1 | When condition first manifested | |||
| Age | ||||
| Range | ||||
| Period | ||||
| string | ||||
| 0..* | Annotation | Extra information about condition | ||
| 0..* | BackboneElement | Procedures that the related person had | ||
| 1..1 | CodeableConcept | Procedures performed on the related person Binding: Procedure Codes (SNOMED CT) (Example) | ||
| 0..1 | CodeableConcept | What happened following the procedure Binding: SNOMED CT Clinical Findings (Example) | ||
| 0..1 | boolean | Whether the procedure contributed to the cause of death | ||
| 0..1 | When the procedure was performed | |||
| Age | ||||
| Range | ||||
| Period | ||||
| string | ||||
| dateTime | ||||
| 0..* | Annotation | Extra information about the procedure | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Key information to flag to healthcare providers Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier | |
| ?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: Flag Status (Required) | |
| Σ | 0..* | CodeableConcept | Clinical, administrative, etc Binding: Flag Category (Example) | |
| Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: Flag Code (Example) | |
| Σ | 1..1 | Reference(Patient | RelatedPerson | Location | Group | Organization | Practitioner | PractitionerRole | PlanDefinition | Medication | Procedure) | Who/What is flag about? | |
| Σ | 0..1 | Period | Time period when flag is active | |
| Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | |
| Σ | 0..1 | Reference(Device | Organization | Patient | RelatedPerson | Practitioner | PractitionerRole) | Flag creator | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Definition of a FormularyItem Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for this formulary item | |
| Σ | 0..1 | CodeableConcept | Codes that identify this formulary item Binding: SNOMED CT Medication Codes (Example) | |
| ?!Σ | 0..1 | code | active | entered-in-error | inactive Binding: FormularyItem Status Codes (Required) | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Genomic Study Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifiers for this genomic study | |
| ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Genomic Study Status (Required) | |
| Σ | 0..* | CodeableConcept | The type of the study (e.g., Familial variant segregation, Functional variation detection, or Gene expression profiling) Binding: Genomic Study Type (Example) | |
| Σ | 1..1 | Reference(Patient | Group | Substance | BiologicallyDerivedProduct | NutritionProduct) | The primary subject of the genomic study | |
| Σ | 0..1 | Reference(Encounter) | The healthcare event with which this genomics study is associated | |
| 0..1 | dateTime | When the genomic study was started | ||
| 0..* | Reference(ServiceRequest | Task) | Event resources that the genomic study is based on | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Healthcare professional who requested or referred the genomic study | ||
| 0..* | Reference(Practitioner | PractitionerRole) | Healthcare professionals who interpreted the genomic study | ||
| 0..* | CodeableReference(Condition | Observation) | Why the genomic study was performed | ||
| 0..1 | canonical(PlanDefinition) | The defined protocol that describes the study | ||
| 0..1 | uri | The URL pointing to an externally maintained protocol that describes the study | ||
| 0..* | Annotation | Comments related to the genomic study | ||
| 0..1 | markdown | Description of the genomic study | ||
| 0..* | BackboneElement | Genomic Analysis Event | ||
| Σ | 0..* | Identifier | Identifiers for the analysis event | |
| Σ | 0..* | CodeableConcept | Type of the methods used in the analysis (e.g., FISH, Karyotyping, MSI) Binding: Genomic Study Method Type (Example) | |
| 0..* | CodeableConcept | Type of the genomic changes studied in the analysis (e.g., DNA, RNA, or AA change) Binding: Genomic Study Change Type (Example) | ||
| 0..1 | CodeableConcept | Genome build that is used in this analysis Binding: HumanRefSeqNCBIBuildId (Extensible) | ||
| 0..1 | canonical(PlanDefinition | ActivityDefinition) | The defined protocol that describes the analysis | ||
| 0..1 | uri | The URL pointing to an externally maintained protocol that describes the analysis | ||
| Σ | 0..1 | string | Name of the analysis event (human friendly) | |
| Σ | 0..* | Reference(Any) | What the genomic analysis is about, when it is not about the subject of record | |
| Σ | 0..* | Reference(Specimen) | The specimen used in the analysis event | |
| 0..1 | dateTime | The date of the analysis event | ||
| 0..* | Annotation | Any notes capture with the analysis event | ||
| 0..1 | Reference(Procedure | Task) | The protocol that was performed for the analysis event | ||
| 0..* | Reference(DocumentReference | Observation) | The genomic regions to be studied in the analysis (BED file) | ||
| 0..* | Reference(DocumentReference | Observation) | Genomic regions actually called in the analysis event (BED file) | ||
| 0..* | BackboneElement | Inputs for the analysis event | ||
| Σ | 0..1 | Reference(DocumentReference) | File containing input data | |
| 0..1 | CodeableConcept | Type of input data (e.g., BAM, CRAM, or FASTA) Binding: Genomic Study Data Format (Example) | ||
| 0..1 | The analysis event or other GenomicStudy that generated this input file | |||
| Identifier | ||||
| Reference(GenomicStudy) | ||||
| 0..* | BackboneElement | Outputs for the analysis event | ||
| Σ | 0..1 | Reference(DocumentReference) | File containing output data | |
| Σ | 0..1 | CodeableConcept | Type of output data (e.g., VCF, MAF, or BAM) Binding: Genomic Study Data Format (Example) | |
| 0..* | BackboneElement | Performer for the analysis event | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization | Device) | The organization, healthcare professional, or others who participated in performing this analysis | ||
| 0..1 | CodeableConcept | Role of the actor for this analysis | ||
| 0..* | BackboneElement | Devices used for the analysis (e.g., instruments, software), with settings and parameters | ||
| 0..1 | Reference(Device) | Device used for the analysis | ||
| 0..1 | CodeableConcept | Specific function for the device used for the analysis | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Describes the intended objective(s) for a patient, group or organization Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | External Ids for this goal | ||
| ?!Σ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: Goal Lifecycle Status (Required) | |
| Σ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: Goal Achievement Status (Preferred) | |
| Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: Goal Category (Example) | |
| 0..1 | boolean | After meeting the goal, ongoing activity is needed to sustain the goal objective | ||
| Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: Goal Priority (Preferred) | |
| Σ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMED CT Clinical Findings (Example) | |
| Σ | 1..1 | Reference(Patient | Group | Organization) | Who this goal is intended for | |
| Σ | 0..1 | When goal pursuit begins Binding: Goal Start Event (Example) | ||
| date | ||||
| CodeableConcept | ||||
| C | 0..* | BackboneElement | Target outcome for the goal + Rule: Goal.target.measure is required if Goal.target.detail is populated | |
| ΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINC Codes (Example) | |
| ΣC | 0..1 | The target value to be achieved Binding: GoalTargetDetail (Example) | ||
| Quantity | ||||
| Range | ||||
| CodeableConcept | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| Ratio | ||||
| Σ | 0..1 | Reach goal on or before | ||
| date | ||||
| Duration | ||||
| Σ | 0..1 | date | When goal status took effect | |
| 0..1 | string | Reason for current status | ||
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | CareTeam) | Who's responsible for creating Goal? | |
| 0..* | Reference(Condition | Observation | MedicationStatement | MedicationRequest | NutritionOrder | ServiceRequest | RiskAssessment | Procedure) | Issues addressed by this goal | ||
| 0..* | Annotation | Comments about the goal | ||
| 0..* | CodeableReference(Observation) | What result was achieved regarding the goal? Binding: SNOMED CT Clinical Findings (Example) | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | Definition of a graph of resources + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||||||
| ΣC | 0..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |||||
| Σ | 0..* | Identifier | Additional identifier for the GraphDefinition (business identifier) | |||||
| Σ | 0..1 | string | Business version of the graph definition | |||||
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| ΣC | 1..1 | string | Name for this graph definition (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this graph definition (human friendly) | |||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
| Σ | 0..1 | dateTime | Date last changed | |||||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| T | 0..1 | markdown | Natural language description of the graph definition | |||||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for graph definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| T | 0..1 | markdown | Why this graph definition is defined | |||||
| T | 0..1 | markdown | Use and/or publishing restrictions | |||||
| T | 0..1 | string | Copyright holder and year(s) | |||||
| 0..1 | id | Starting Node | ||||||
| 0..* | BackboneElement | Potential target for the link | ||||||
| 1..1 | id | Internal ID - target for link references | ||||||
| 0..1 | string | Why this node is specified | ||||||
| 1..1 | code | Type of resource this link refers to Binding: Version Independent Resource Types (All) (Required)
| ||||||
| 0..1 | canonical(StructureDefinition) | Profile for the target resource | ||||||
| 0..* | BackboneElement | Links this graph makes rules about | ||||||
| 0..1 | string | Why this link is specified | ||||||
| 0..1 | integer | Minimum occurrences for this link | ||||||
| 0..1 | string | Maximum occurrences for this link | ||||||
| 1..1 | id | Source Node for this link | ||||||
| 0..1 | string | Path in the resource that contains the link | ||||||
| 0..1 | string | Which slice (if profiled) | ||||||
| 1..1 | id | Target Node for this link | ||||||
| 0..1 | string | Criteria for reverse lookup | ||||||
| 0..* | BackboneElement | Compartment Consistency Rules | ||||||
| 1..1 | code | where | requires Binding: Graph Compartment Use (Required) | ||||||
| 1..1 | code | identical | matching | different | custom Binding: Graph Compartment Rule (Required) | ||||||
| 1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare Binding: Compartment Type (Required) | ||||||
| 0..1 | string | Custom rule, as a FHIRPath expression | ||||||
| 0..1 | string | Documentation for FHIRPath expression | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Group of multiple entities Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business Identifier for this Group | |
| ?!Σ | 0..1 | boolean | Whether this group's record is in active use | |
| Σ | 1..1 | code | person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen Binding: Group Type (Required) | |
| Σ | 1..1 | code | definitional | enumerated Binding: Group Membership Basis (Required) | |
| Σ | 0..1 | CodeableConcept | Kind of Group members Binding: GroupKind (Example) | |
| Σ | 0..1 | string | Label for Group | |
| 0..1 | markdown | Natural language description of the group | ||
| Σ | 0..1 | unsignedInt | Number of members | |
| Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | |
| Σ | 0..* | BackboneElement | Include / Exclude group members by Trait | |
| Σ | 1..1 | CodeableConcept | Kind of characteristic Binding: GroupCharacteristicKind (Example) | |
| Σ | 1..1 | Value held by characteristic Binding: GroupCharacteristicValue (Example) | ||
| CodeableConcept | ||||
| boolean | ||||
| Quantity | ||||
| Range | ||||
| Reference() | ||||
| Σ | 1..1 | boolean | Group includes or excludes | |
| 0..1 | Period | Period over which characteristic is tested | ||
| 0..* | BackboneElement | Who or what is in group | ||
| 1..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) | Reference to the group member | ||
| 0..1 | Period | Period member belonged to the group | ||
| 0..1 | boolean | If member is no longer in group | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | The formal response to a guidance request Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | Identifier | The identifier of the request associated with this response, if any | |
| Σ | 0..* | Identifier | Business identifier | |
| Σ | 1..1 | What guidance was requested Binding: Guidance Module Code (Example) | ||
| uri | ||||
| canonical() | ||||
| CodeableConcept | ||||
| ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error Binding: Guidance Response Status (Required) | |
| 0..1 | Reference(Patient | Group) | Patient the request was performed for | ||
| 0..1 | Reference(Encounter) | Encounter during which the response was returned | ||
| 0..1 | dateTime | When the guidance response was processed | ||
| 0..1 | Reference(Device) | Device returning the guidance | ||
| 0..* | CodeableReference() | Why guidance is needed | ||
| 0..* | Annotation | Additional notes about the response | ||
| 0..1 | Reference(OperationOutcome) | Messages resulting from the evaluation of the artifact or artifacts | ||
| 0..1 | Reference(Parameters) | The output parameters of the evaluation, if any | ||
| 0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) | Proposed actions, if any | ||
| 0..* | DataRequirement | Additional required data | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | The details of a healthcare service available at a location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | External identifiers for this item | |||||
| ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | |||||
| Σ | 0..1 | Reference(Organization) | Organization that provides this service | |||||
| 0..* | Reference(HealthcareService) | The service within which this service is offered | ||||||
| Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: Service Category (Example) | |||||
| Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (Example) | |||||
| Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set (Preferred) | |||||
| Σ | 0..* | Reference(Location) | Location(s) where service may be provided | |||||
| Σ | 0..1 | string | Description of service as presented to a consumer while searching | |||||
| Σ | 0..1 | markdown | Additional description and/or any specific issues not covered elsewhere | |||||
| 0..1 | markdown | Extra details about the service that can't be placed in the other fields | ||||||
| Σ | 0..1 | Attachment | Facilitates quick identification of the service | |||||
| 0..* | ExtendedContactDetail | Official contact details for the HealthcareService | ||||||
| 0..* | Reference(Location) | Location(s) service is intended for/available to | ||||||
| 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions (Example) | ||||||
| 0..* | BackboneElement | Specific eligibility requirements required to use the service | ||||||
| 0..1 | CodeableConcept | Coded value for the eligibility Binding: ServiceEligibility (Example) | ||||||
| 0..1 | markdown | Describes the eligibility conditions for the service | ||||||
| 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (Example) | ||||||
| 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: Service Mode (Example) | ||||||
| 0..* | CodeableConcept | The language that this service is offered in Binding: All Languages (Required)
| ||||||
| 0..* | CodeableConcept | Ways that the service accepts referrals Binding: Referral Method (Example) | ||||||
| 0..1 | boolean | If an appointment is required for access to this service | ||||||
| 0..* | Availability | Times the healthcare service is available (including exceptions) | ||||||
| 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A selection of DICOM SOP instances and/or frames Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business Identifier for Imaging Selection | |
| ?!Σ | 1..1 | code | available | entered-in-error | unknown Binding: Imaging Selection Status (Required) | |
| Σ | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | Specimen) | Subject of the selected instances | |
| Σ | 0..1 | instant | Date / Time when this imaging selection was created | |
| Σ | 0..* | BackboneElement | Selector of the instances (human or machine) | |
| Σ | 0..1 | CodeableConcept | Type of performer Binding: ImagingStudy series performer function (Extensible) | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) | Author (human or machine) | |
| Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request | |
| Σ | 0..* | CodeableConcept | Classifies the imaging selection Binding: KeyObjectSelectionDocumentTitle (Example) | |
| Σ | 1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (Example) | |
| Σ | 0..1 | id | DICOM Study Instance UID | |
| Σ | 0..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived | |
| Σ | 0..* | Reference(Endpoint) | The network service providing retrieval for the images referenced in the imaging selection | |
| Σ | 0..1 | id | DICOM Series Instance UID | |
| Σ | 0..1 | unsignedInt | DICOM Series Number | |
| Σ | 0..1 | id | The Frame of Reference UID for the selected images | |
| Σ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMED CT Body Structures (Example) | |
| Σ | 0..* | Reference(ImagingSelection) | Related resource that is the focus for the imaging selection | |
| Σ | 0..* | BackboneElement | The selected instances | |
| Σ | 1..1 | id | DICOM SOP Instance UID | |
| Σ | 0..1 | unsignedInt | DICOM Instance Number | |
| 0..1 | Coding | DICOM SOP Class UID Binding: sopClass (Extensible) | ||
| 0..* | string | The selected subset of the SOP Instance | ||
| 0..* | BackboneElement | A specific 2D region in a DICOM image / frame | ||
| 1..1 | code | point | polyline | interpolated | circle | ellipse Binding: Imaging Selection2 D Graphic Type (Required) | ||
| 1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y) coordinates. | ||
| 0..* | BackboneElement | A specific 3D region in a DICOM frame of reference | ||
| 1..1 | code | point | multipoint | polyline | polygon | ellipse | ellipsoid Binding: Imaging Selection3 D Graphic Type (Required) | ||
| 1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y, z) coordinates. | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A set of images produced in single study (one or more series of references images) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifiers for the whole study | |
| ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Imaging Study Status (Required) | |
| Σ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (Extensible) | |
| Σ | 1..1 | Reference(Patient | Device | Group) | Who or what is the subject of the study | |
| Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | |
| Σ | 0..1 | dateTime | When the study was started | |
| Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled | |
| Σ | 0..* | Reference(Procedure) | Part of referenced event | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | |
| Σ | 0..* | Reference(Endpoint) | Study access endpoint | |
| Σ | 0..1 | unsignedInt | Number of Study Related Series | |
| Σ | 0..1 | unsignedInt | Number of Study Related Instances | |
| Σ | 0..* | CodeableReference(PlanDefinition | ActivityDefinition) | The performed procedure or code Binding: ImagingProcedureCode (Preferred) | |
| Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | |
| Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the study was requested / performed Binding: Procedure Reason Codes (Example) | |
| Σ | 0..* | Annotation | User-defined comments | |
| Σ | 0..1 | string | Institution-generated description | |
| Σ | 0..* | BackboneElement | Each study has one or more series of instances | |
| Σ | 1..1 | id | DICOM Series Instance UID for the series | |
| Σ | 0..1 | unsignedInt | Numeric identifier of this series | |
| Σ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (Extensible) | |
| Σ | 0..1 | string | A short human readable summary of the series | |
| Σ | 0..1 | unsignedInt | Number of Series Related Instances | |
| Σ | 0..* | Reference(Endpoint) | Series access endpoint | |
| Σ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMED CT Body Structures (Example) | |
| Σ | 0..1 | CodeableConcept | Body part laterality Binding: Laterality (Example) | |
| Σ | 0..* | Reference(Specimen) | Specimen imaged | |
| Σ | 0..1 | dateTime | When the series started | |
| Σ | 0..* | BackboneElement | Who performed the series | |
| Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudy series performer function (Extensible) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | |
| 0..* | BackboneElement | A single SOP instance from the series | ||
| 1..1 | id | DICOM SOP Instance UID | ||
| 1..1 | Coding | DICOM class type Binding: sopClass (Extensible) | ||
| 0..1 | unsignedInt | The number of this instance in the series | ||
| 0..1 | string | Description of instance | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Immunization event information Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business identifier | ||
| Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | |
| ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Immunization Status Codes (Required) | |
| 0..1 | CodeableConcept | Reason for current status Binding: Immunization Status Reason Codes (Example) | ||
| Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Administered Value Set (Example) | |
| 0..1 | CodeableReference(Medication) | Product that was administered | ||
| 0..1 | CodeableReference(Organization) | Vaccine manufacturer | ||
| 0..1 | string | Vaccine lot number | ||
| 0..1 | date | Vaccine expiration date | ||
| Σ | 1..1 | Reference(Patient) | Who was immunized | |
| 0..1 | Reference(Encounter) | Encounter immunization was part of | ||
| 0..* | Reference(Any) | Additional information in support of the immunization | ||
| Σ | 1..1 | Vaccine administration date | ||
| dateTime | ||||
| string | ||||
| Σ | 0..1 | boolean | Indicates context the data was captured in | |
| 0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: Immunization Origin Codes (Example) | ||
| 0..1 | Reference(Location) | Where immunization occurred | ||
| 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (Example) | ||
| 0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (Example) | ||
| 0..1 | SimpleQuantity | Amount of vaccine administered | ||
| Σ | 0..* | BackboneElement | Who performed event | |
| Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Function Codes (Extensible) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Individual or organization who was performing | |
| Σ | 0..* | Annotation | Additional immunization notes | |
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: Immunization Reason Codes (Example) | ||
| ?!Σ | 0..1 | boolean | Dose potency | |
| 0..* | CodeableConcept | Reason for being subpotent Binding: Immunization Subpotent Reason (Example) | ||
| 0..* | BackboneElement | Patient eligibility for a specific vaccination program | ||
| 1..1 | CodeableConcept | The program that eligibility is declared for Binding: Vaccine Funding Programs (Example) | ||
| 1..1 | CodeableConcept | The patient's eligibility status for the program Binding: Immunization Program Eligibility (Example) | ||
| 0..1 | CodeableConcept | Funding source for the vaccine Binding: Immunization Funding Source (Example) | ||
| 0..* | BackboneElement | Details of a reaction that follows immunization | ||
| 0..1 | dateTime | When reaction started | ||
| 0..1 | CodeableReference(Observation) | Additional information on reaction | ||
| 0..1 | boolean | Indicates self-reported reaction | ||
| 0..* | BackboneElement | Protocol followed by the provider | ||
| 0..1 | string | Name of vaccine series | ||
| 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | ||
| 0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: Immunization Target Disease Codes (Example) | ||
| 1..1 | string | Dose number within series | ||
| 0..1 | string | Recommended number of doses for immunity | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Immunization evaluation information Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business identifier | ||
| ?!Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Evaluation Status Codes (Required) | |
| Σ | 1..1 | Reference(Patient) | Who this evaluation is for | |
| 0..1 | dateTime | Date evaluation was performed | ||
| 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | ||
| Σ | 1..1 | CodeableConcept | The vaccine preventable disease schedule being evaluated Binding: Immunization Target Disease Codes (Example) | |
| Σ | 1..1 | Reference(Immunization) | Immunization being evaluated | |
| Σ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: Immunization Evaluation Dose Status codes (Example) | |
| 0..* | CodeableConcept | Reason why the doese is considered valid, invalid or some other status Binding: Immunization Evaluation Dose Status Reason codes (Example) | ||
| 0..1 | markdown | Evaluation notes | ||
| 0..1 | string | Name of vaccine series | ||
| 0..1 | string | Dose number within series | ||
| 0..1 | string | Recommended number of doses for immunity | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Guidance or advice relating to an immunization Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier | |
| Σ | 1..1 | Reference(Patient) | Who this profile is for | |
| Σ | 1..1 | dateTime | Date recommendation(s) created | |
| 0..1 | Reference(Organization) | Who is responsible for protocol | ||
| ΣC | 1..* | BackboneElement | Vaccine administration recommendations + Rule: One of vaccineCode or targetDisease SHALL be present | |
| ΣC | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccine Administered Value Set (Example) | |
| ΣC | 0..* | CodeableConcept | Disease to be immunized against Binding: Immunization Target Disease Codes (Example) | |
| Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: Vaccine Administered Value Set (Example) | |
| ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: Immunization Recommendation Status Codes (Example) | |
| Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: Immunization Recommendation Reason Codes (Example) | |
| 0..* | BackboneElement | Dates governing proposed immunization | ||
| 1..1 | CodeableConcept | Type of date Binding: Immunization Recommendation Date Criterion Codes (Example) | ||
| 1..1 | dateTime | Recommended date | ||
| 0..1 | markdown | Protocol details | ||
| 0..1 | string | Name of vaccination series | ||
| Σ | 0..1 | string | Recommended dose number within series | |
| 0..1 | string | Recommended number of doses for immunity | ||
| 0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | ||
| 0..* | Reference(Any) | Patient observations supporting recommendation | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A set of rules about how FHIR is used + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the implementation guide (business identifier) | |
| Σ | 0..1 | string | Business version of the implementation guide | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 1..1 | string | Name for this implementation guide (computer friendly) | |
| ΣT | 0..1 | string | Name for this implementation guide (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the implementation guide | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for implementation guide (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this implementation guide is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| Σ | 1..1 | id | NPM Package name for IG | |
| Σ | 0..1 | code | SPDX license code for this IG (or not-open-source) Binding: S P D X License (Required) | |
| ΣC | 1..* | code | FHIR Version(s) this Implementation Guide targets Binding: FHIRVersion (Required) | |
| Σ | 0..* | BackboneElement | Another Implementation guide this depends on | |
| Σ | 1..1 | canonical(ImplementationGuide) | Identity of the IG that this depends on | |
| Σ | 0..1 | id | NPM Package name for IG this depends on | |
| Σ | 0..1 | string | Version of the IG | |
| 0..1 | markdown | Why dependency exists | ||
| Σ | 0..* | BackboneElement | Profiles that apply globally | |
| Σ | 1..1 | code | Type this profile applies to Binding: Resource Types (Required) | |
| Σ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to | |
| C | 0..1 | BackboneElement | Information needed to build the IG + Rule: If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide | |
| C | 0..* | BackboneElement | Grouping used to present related resources in the IG | |
| T | 1..1 | string | Descriptive name for the package | |
| T | 0..1 | markdown | Human readable text describing the package | |
| C | 0..* | BackboneElement | Resource in the implementation guide | |
| 1..1 | Reference(Any) | Location of the resource | ||
| C | 0..* | code | Versions this applies to (if different to IG) Binding: FHIRVersion (Required) | |
| T | 0..1 | string | Human readable name for the resource | |
| T | 0..1 | markdown | Reason why included in guide | |
| 0..1 | boolean | Is this an example | ||
| 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | ||
| C | 0..1 | id | Grouping this is part of | |
| C | 0..1 | BackboneElement | Page/Section in the Guide + Rule: Source must be absent if 'generated' is generated | |
| TC | 0..1 | Source for page | ||
| url | ||||
| string | ||||
| markdown | ||||
| 1..1 | url | Name of the page when published | ||
| T | 1..1 | string | Short title shown for navigational assistance | |
| C | 1..1 | code | html | markdown | xml | generated Binding: Guide Page Generation (Required) | |
| 0..* | see page | Nested Pages / Sections | ||
| 0..* | BackboneElement | Defines how IG is built by tools | ||
| 1..1 | Coding | Code that identifies parameter Binding: Guide Parameter Code (Extensible) | ||
| 1..1 | string | Value for named type | ||
| 0..* | BackboneElement | A template for building resources | ||
| 1..1 | code | Type of template specified | ||
| 1..1 | string | The source location for the template | ||
| 0..1 | string | The scope in which the template applies | ||
| 0..1 | BackboneElement | Information about an assembled IG | ||
| Σ | 0..1 | url | Location of rendered implementation guide | |
| Σ | 1..* | BackboneElement | Resource in the implementation guide | |
| Σ | 1..1 | Reference(Any) | Location of the resource | |
| 0..1 | boolean | Is this an example | ||
| 0..* | canonical(StructureDefinition) | Profile(s) this is an example of | ||
| 0..1 | url | Relative path for page in IG | ||
| 0..* | BackboneElement | HTML page within the parent IG | ||
| 1..1 | string | HTML page name | ||
| 0..1 | string | Title of the page, for references | ||
| 0..* | string | Anchor available on the page | ||
| 0..* | string | Image within the IG | ||
| 0..* | string | Additional linkable file in IG | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An ingredient of a manufactured item or pharmaceutical product + Rule: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | Identifier | An identifier or code by which the ingredient can be referenced | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..* | Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition) | The product which this ingredient is a constituent part of | |
| Σ | 1..1 | CodeableConcept | Purpose of the ingredient within the product, e.g. active, inactive Binding: Ingredient Role (Example) | |
| Σ | 0..* | CodeableConcept | Precise action within the drug product, e.g. antioxidant, alkalizing agent Binding: Ingredient Function (Example) | |
| Σ | 0..1 | CodeableConcept | A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink | |
| ΣC | 0..1 | boolean | If the ingredient is a known or suspected allergen | |
| 0..1 | markdown | A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying | ||
| Σ | 0..* | BackboneElement | An organization that manufactures this ingredient | |
| Σ | 0..1 | code | allowed | possible | actual Binding: Ingredient Manufacturer Role (Required) | |
| Σ | 1..1 | Reference(Organization) | An organization that manufactures this ingredient | |
| ΣC | 1..1 | BackboneElement | The substance that comprises this ingredient | |
| ΣC | 1..1 | CodeableReference(SubstanceDefinition) | A code or full resource that represents the ingredient substance Binding: SNOMED CT Substance Codes (Example) | |
| Σ | 0..* | BackboneElement | The quantity of substance, per presentation, or per volume or mass, and type of quantity | |
| Σ | 0..1 | The quantity of substance in the unit of presentation | ||
| Ratio | ||||
| RatioRange | ||||
| CodeableConcept | ||||
| Quantity | ||||
| Σ | 0..1 | string | Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) | |
| Σ | 0..1 | The strength per unitary volume (or mass) | ||
| Ratio | ||||
| RatioRange | ||||
| CodeableConcept | ||||
| Quantity | ||||
| Σ | 0..1 | string | Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio) | |
| Σ | 0..1 | CodeableConcept | A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt) | |
| Σ | 0..1 | string | When strength is measured at a particular point or distance | |
| Σ | 0..* | CodeableConcept | Where the strength range applies Binding: Country ValueSet (Example) | |
| Σ | 0..* | BackboneElement | Strength expressed in terms of a reference substance | |
| Σ | 1..1 | CodeableReference(SubstanceDefinition) | Relevant reference substance Binding: SNOMED CT Substance Codes (Example) | |
| Σ | 1..1 | Strength expressed in terms of a reference substance | ||
| Ratio | ||||
| RatioRange | ||||
| Quantity | ||||
| Σ | 0..1 | string | When strength is measured at a particular point or distance | |
| Σ | 0..* | CodeableConcept | Where the strength range applies Binding: Country ValueSet (Example) | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Details of a Health Insurance product/plan provided by an organization + Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| ΣC | 0..* | Identifier | Business Identifier for Product | |
| ?!Σ | 0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..* | CodeableConcept | Kind of product Binding: Insurance Plan Type (Example) | |
| ΣC | 0..1 | string | Official name | |
| 0..* | string | Alternate names | ||
| 0..1 | Period | When the product is available | ||
| Σ | 0..1 | Reference(Organization) | Product issuer | |
| Σ | 0..1 | Reference(Organization) | Product administrator | |
| Σ | 0..* | Reference(Location) | Where product applies | |
| 0..* | ExtendedContactDetail | Official contact details relevant to the health insurance plan/product | ||
| 0..* | Reference(Endpoint) | Technical endpoint | ||
| 0..* | Reference(Organization) | What networks are Included | ||
| 0..* | BackboneElement | Coverage details | ||
| 1..1 | CodeableConcept | Type of coverage | ||
| 0..* | Reference(Organization) | What networks provide coverage | ||
| 1..* | BackboneElement | List of benefits | ||
| 1..1 | CodeableConcept | Type of benefit | ||
| 0..1 | string | Referral requirements | ||
| 0..* | BackboneElement | Benefit limits | ||
| 0..1 | Quantity | Maximum value allowed | ||
| 0..1 | CodeableConcept | Benefit limit details | ||
| 0..* | BackboneElement | Plan details | ||
| Σ | 0..* | Identifier | Business Identifier for Product | |
| 0..1 | CodeableConcept | Type of plan | ||
| Σ | 0..* | Reference(Location) | Where product applies | |
| 0..* | Reference(Organization) | What networks provide coverage | ||
| 0..* | BackboneElement | Overall costs | ||
| 0..1 | CodeableConcept | Type of cost | ||
| 0..1 | positiveInt | Number of enrollees | ||
| 0..1 | Money | Cost value | ||
| 0..1 | string | Additional cost information | ||
| 0..* | BackboneElement | Specific costs | ||
| 1..1 | CodeableConcept | General category of benefit | ||
| 0..* | BackboneElement | Benefits list | ||
| 1..1 | CodeableConcept | Type of specific benefit | ||
| 0..* | BackboneElement | List of the costs | ||
| 1..1 | CodeableConcept | Type of cost | ||
| 0..1 | CodeableConcept | in-network | out-of-network | other Binding: Benefit Cost Applicability (Required) | ||
| 0..* | CodeableConcept | Additional information about the cost | ||
| 0..1 | Quantity | The actual cost value | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| D | DomainResource | A functional description of an inventory item used in inventory and supply-related workflows Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for the inventory item | |
| Σ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: InventoryItem Status Codes (Required) | |
| Σ | 0..* | CodeableConcept | Category or class of the item | |
| Σ | 0..* | CodeableConcept | Code designating the specific type of item | |
| Σ | 0..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name or others | |
| Σ | 1..1 | Coding | The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItem Name Typess (Preferred) | |
| Σ | 1..1 | code | The language used to express the item name Binding: Common Languages (Required) | |
| Σ | 1..1 | string | The name or designation of the item | |
| 0..* | BackboneElement | Organization(s) responsible for the product | ||
| 1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other | ||
| 1..1 | Reference(Organization) | An organization that is associated with the item | ||
| 0..1 | BackboneElement | Descriptive characteristics of the item | ||
| 0..1 | code | The language that is used in the item description Binding: Common Languages (Required) | ||
| 0..1 | string | Textual description of the item | ||
| Σ | 0..* | CodeableConcept | The usage status like recalled, in use, discarded | |
| Σ | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted | |
| Σ | 0..1 | SimpleQuantity | Net content or amount present in the item | |
| 0..* | BackboneElement | Association with other items or products | ||
| Σ | 1..1 | CodeableConcept | The type of association between the device and the other item | |
| Σ | 1..1 | Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) | The related item or product | |
| Σ | 1..1 | Ratio | The quantity of the product in this product | |
| 0..* | BackboneElement | Characteristic of the item | ||
| 1..1 | CodeableConcept | The characteristic that is being defined | ||
| 1..1 | The value of the attribute | |||
| string | ||||
| integer | ||||
| decimal | ||||
| boolean | ||||
| url | ||||
| dateTime | ||||
| Quantity | ||||
| Range | ||||
| Ratio | ||||
| Annotation | ||||
| Address | ||||
| Duration | ||||
| CodeableConcept | ||||
| 0..1 | BackboneElement | Instances or occurrences of the product | ||
| 0..* | Identifier | The identifier for the physical instance, typically a serial number | ||
| 0..1 | string | The lot or batch number of the item | ||
| 0..1 | dateTime | The expiry date or date and time for the product | ||
| 0..1 | Reference(Patient | Organization) | The subject that the item is associated with | ||
| 0..1 | Reference(Location) | The location that the item is associated with | ||
| 0..1 | Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) | Link to a product resource used in clinical workflows | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A report of inventory or stock items Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for the report | |
| ?!Σ | 1..1 | code | draft | requested | active | entered-in-error Binding: Inventory Report Status (Required) | |
| ?!Σ | 1..1 | code | snapshot | difference Binding: Inventory Count Type (Required) | |
| Σ | 0..1 | CodeableConcept | addition | subtraction | |
| Σ | 0..1 | CodeableConcept | The reason for this count - regular count, ad-hoc count, new arrivals, etc | |
| Σ | 1..1 | dateTime | When the report has been submitted | |
| 0..1 | Reference(Practitioner | Patient | RelatedPerson | Device) | Who submits the report | ||
| 0..1 | Period | The period the report refers to | ||
| Σ | 0..* | BackboneElement | An inventory listing section (grouped by any of the attributes) | |
| 0..1 | Reference(Location) | Location of the inventory items | ||
| Σ | 0..1 | CodeableConcept | The status of the items that are being reported | |
| 0..1 | dateTime | The date and time when the items were counted | ||
| Σ | 0..* | BackboneElement | The item or items in this listing | |
| Σ | 0..1 | CodeableConcept | The inventory category or classification of the items being reported | |
| Σ | 1..1 | Quantity | The quantity of the item or items being reported | |
| Σ | 1..1 | CodeableReference(Medication | Device | Medication | NutritionProduct | InventoryItem | BiologicallyDerivedProduct | InventoryItem) | The code or reference to the item type | |
| 0..* | Annotation | A note associated with the InventoryReport | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Invoice containing ChargeItems from an Account Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business Identifier for item | |
| ?!Σ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: Invoice Status (Required) | |
| 0..1 | string | Reason for cancellation of this Invoice | ||
| Σ | 0..1 | CodeableConcept | Type of Invoice | |
| Σ | 0..1 | Reference(Patient | Group) | Recipient(s) of goods and services | |
| Σ | 0..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | |
| 0..1 | dateTime | DEPRICATED | ||
| Σ | 0..1 | dateTime | When posted | |
| Σ | 0..1 | Billing date or period | ||
| date | ||||
| Period | ||||
| 0..* | BackboneElement | Participant in creation of this Invoice | ||
| 0..1 | CodeableConcept | Type of involvement in creation of this Invoice | ||
| 1..1 | Reference(Practitioner | Organization | Patient | PractitionerRole | Device | RelatedPerson) | Individual who was involved | ||
| 0..1 | Reference(Organization) | Issuing Organization of Invoice | ||
| 0..1 | Reference(Account) | Account that is being balanced | ||
| 0..* | BackboneElement | Line items of this Invoice | ||
| 0..1 | positiveInt | Sequence number of line item | ||
| 0..1 | Service data or period | |||
| date | ||||
| Period | ||||
| 1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | |||
| Reference(ChargeItem) | ||||
| CodeableConcept | ||||
| 0..* | MonetaryComponent | Components of total line item price | ||
| 0..* | MonetaryComponent | Components of Invoice total | ||
| Σ | 0..1 | Money | Net total of this Invoice | |
| Σ | 0..1 | Money | Gross total of this Invoice | |
| 0..1 | markdown | Payment details | ||
| 0..* | Annotation | Comments made about the invoice | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Represents a library of quality improvement components + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the library | |
| Σ | 0..1 | string | Business version of the library | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this library (computer friendly) | |
| ΣT | 0..1 | string | Name for this library (human friendly) | |
| T | 0..1 | string | Subordinate title of the library | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: Library Type (Extensible) | |
| 0..1 | Type of individual the library content is focused on Binding: Participant Resource Types (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the library | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this library is defined | |
| T | 0..1 | markdown | Describes the clinical usage of the library | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the library was approved by publisher | ||
| 0..1 | date | When the library was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the library is expected to be used | |
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the content | ||
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| 0..* | ContactDetail | Who endorsed the content | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| 0..* | ParameterDefinition | Parameters defined by the library | ||
| 0..* | DataRequirement | What data is referenced by this library | ||
| Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Links records for 'same' item + Rule: Must have at least two items Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | boolean | Whether this linkage assertion is active or not | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for linkages | |
| ΣC | 1..* | BackboneElement | Item to be linked | |
| Σ | 1..1 | code | source | alternate | historical Binding: Linkage Type (Required) | |
| Σ | 1..1 | Reference(Any) | Resource being linked | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A list is a curated collection of resources + Rule: A list can only have an emptyReason if it is empty Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business identifier | ||
| ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: List Status (Required) | |
| ?!Σ | 1..1 | code | working | snapshot | changes Binding: List Mode (Required) | |
| Σ | 0..1 | string | Descriptive name for the list | |
| Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: Example Use Codes for List (Example) | |
| Σ | 0..* | Reference(Any) | If all resources have the same subject(s) | |
| 0..1 | Reference(Encounter) | Context in which list created | ||
| Σ | 0..1 | dateTime | When the list was prepared | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device | Organization | RelatedPerson | CareTeam) | Who and/or what defined the list contents (aka Author) | |
| 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (Preferred) | ||
| 0..* | Annotation | Comments about the list | ||
| C | 0..* | BackboneElement | Entries in the list This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy. | |
| 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Patient Medicine Change Types (Example) | ||
| ?! | 0..1 | boolean | If this item is actually marked as deleted | |
| 0..1 | dateTime | When item added to list | ||
| 1..1 | Reference(Any) | Actual entry | ||
| C | 0..1 | CodeableConcept | Why list is empty Binding: List Empty Reasons (Preferred) | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Details and position information for a place Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique code or number identifying the location to its users | |
| ?!Σ | 0..1 | code | active | suspended | inactive Binding: Location Status (Required) | |
| Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (Preferred) | |
| Σ | 0..1 | string | Name of the location as used by humans | |
| 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | ||
| Σ | 0..1 | markdown | Additional details about the location that could be displayed as further information to identify the location beyond its name | |
| Σ | 0..1 | code | instance | kind Binding: Location Mode (Required) | |
| Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (Extensible) | |
| 0..* | ExtendedContactDetail | Official contact details for the location | ||
| 0..1 | Address | Physical location | ||
| Σ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Form (Example) | |
| 0..1 | BackboneElement | The absolute geographic location | ||
| 1..1 | decimal | Longitude with WGS84 datum | ||
| 1..1 | decimal | Latitude with WGS84 datum | ||
| 0..1 | decimal | Altitude with WGS84 datum | ||
| Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep | |
| 0..1 | Reference(Location) | Another Location this one is physically a part of | ||
| 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: Location Characteristic (Example) | ||
| 0..* | Availability | What days/times during a week is this location usually open (including exceptions) | ||
| 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | ||
| 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique identifier | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | string | A descriptive name applied to this item | |
| Σ | 1..1 | CodeableConcept | Dose form as manufactured (before any necessary transformation) Binding: Manufactured Dose Form (Example) | |
| Σ | 0..1 | CodeableConcept | The “real-world” units in which the quantity of the item is described Binding: Unit Of Presentation (Example) | |
| Σ | 0..* | Reference(Organization) | Manufacturer of the item, one of several possible | |
| Σ | 0..* | MarketingStatus | Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated | |
| Σ | 0..* | CodeableConcept | The ingredients of this manufactured item. Only needed if these are not specified by incoming references from the Ingredient resource Binding: SNOMED CT Substance Codes (Example) | |
| Σ | 0..* | BackboneElement | General characteristics of this item | |
| Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: Product Characteristic (Example) | |
| Σ | 0..1 | A value for the characteristic | ||
| CodeableConcept | ||||
| Quantity | ||||
| date | ||||
| boolean | ||||
| markdown | ||||
| Attachment | ||||
| Reference(Binary) | ||||
| Σ | 0..* | BackboneElement | Physical parts of the manufactured item, that it is intrisically made from. This is distinct from the ingredients that are part of its chemical makeup | |
| Σ | 1..1 | CodeableConcept | Defining type of the component e.g. shell, layer, ink | |
| Σ | 0..* | CodeableConcept | The function of this component within the item e.g. delivers active ingredient, masks taste | |
| Σ | 0..* | Quantity | The measurable amount of total quantity of all substances in the component, expressable in different ways (e.g. by mass or volume) | |
| Σ | 0..* | BackboneElement | A reference to a constituent of the manufactured item as a whole, linked here so that its component location within the item can be indicated. This not where the item's ingredient are primarily stated (for which see Ingredient.for or ManufacturedItemDefinition.ingredient) | |
| Σ | 0..* | Quantity | The measurable amount of the substance, expressable in different ways (e.g. by mass or volume) | |
| Σ | 0..* | CodeableConcept | The physical location of the constituent/ingredient within the component | |
| Σ | 0..* | CodeableConcept | The function of this constituent within the component e.g. binder | |
| Σ | 0..* | CodeableReference(Ingredient) | The ingredient that is the constituent of the given component | |
| Σ | 0..* | see property | General characteristics of this component | |
| Σ | 0..* | see component | A component that this component contains or is made from | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A quality measure definition + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Stratifier SHALL be either a single criteria or a set of criteria components Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the measure | |
| Σ | 0..1 | string | Business version of the measure | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this measure (computer friendly) | |
| ΣT | 0..1 | string | Name for this measure (human friendly) | |
| T | 0..1 | string | Subordinate title of the measure | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: Participant Resource Types (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | code | Population basis Binding: All FHIR Types (Required) | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the measure | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this measure is defined | |
| T | 0..1 | markdown | Describes the clinical usage of the measure | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the measure was approved by publisher | ||
| 0..1 | date | When the measure was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the measure is expected to be used | |
| XD | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the content | ||
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| 0..* | ContactDetail | Who endorsed the content | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| 0..* | canonical(Library) | Logic used by the measure | ||
| Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content | |
| Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (Extensible) | |
| Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (Example) | |
| Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: Composite Measure Scoring (Extensible) | |
| Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: Measure Type (Extensible) | |
| Σ | 0..1 | markdown | How risk adjustment is applied for this measure | |
| Σ | 0..1 | markdown | How is rate aggregation performed for this measure | |
| Σ | 0..1 | markdown | Detailed description of why the measure exists | |
| Σ | 0..1 | markdown | Summary of clinical guidelines | |
| Σ | 0..1 | CodeableConcept | increase | decrease Binding: Measure Improvement Notation (Required) | |
| 0..* | BackboneElement | Defined terms used in the measure documentation | ||
| 0..1 | CodeableConcept | What term? Binding: Measure Definition Example (Example) | ||
| 0..1 | markdown | Meaning of the term | ||
| ΣXD | 0..1 | markdown | Additional guidance for implementers (deprecated) | |
| C | 0..* | BackboneElement | Population criteria group | |
| C | 0..1 | string | Unique id for group in measure + Warning: Link ids should be 255 characters or less | |
| 0..1 | CodeableConcept | Meaning of the group Binding: Measure Group Example (Example) | ||
| 0..1 | markdown | Summary description | ||
| Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: Measure Type (Extensible) | |
| 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: Participant Resource Types (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | code | Population basis Binding: All FHIR Types (Required) | |
| Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (Extensible) | |
| Σ | 0..1 | CodeableConcept | What units? Binding: Measure Scoring Unit (Example) | |
| Σ | 0..1 | markdown | How is rate aggregation performed for this measure | |
| Σ | 0..1 | CodeableConcept | increase | decrease Binding: Measure Improvement Notation (Required) | |
| 0..* | canonical(Library) | Logic used by the measure group | ||
| 0..* | BackboneElement | Population criteria | ||
| C | 0..1 | string | Unique id for population in measure + Warning: Link ids should be 255 characters or less | |
| 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Population Type (Extensible) | ||
| 0..1 | markdown | The human readable description of this population criteria | ||
| 0..1 | Expression | The criteria that defines this population | ||
| 0..1 | Reference(Group) | A group resource that defines this population | ||
| 0..1 | string | Which population | ||
| 0..1 | CodeableConcept | Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) Binding: Measure Aggregate Method (Extensible) | ||
| C | 0..* | BackboneElement | Stratifier criteria for the measure | |
| C | 0..1 | string | Unique id for stratifier in measure + Warning: Link ids should be 255 characters or less | |
| C | 0..1 | CodeableConcept | Meaning of the stratifier Binding: Measure Stratifier Example (Example) | |
| C | 0..1 | markdown | The human readable description of this stratifier | |
| C | 0..1 | Expression | How the measure should be stratified | |
| 0..1 | Reference(Group) | A group resource that defines this population | ||
| C | 0..* | BackboneElement | Stratifier criteria component for the measure | |
| C | 0..1 | string | Unique id for stratifier component in measure + Warning: Link ids should be 255 characters or less | |
| 0..1 | CodeableConcept | Meaning of the stratifier component Binding: Measure Stratifier Example (Example) | ||
| 0..1 | markdown | The human readable description of this stratifier component | ||
| 0..1 | Expression | Component of how the measure should be stratified | ||
| 0..1 | Reference(Group) | A group resource that defines this population | ||
| 0..* | BackboneElement | What other data should be reported with the measure | ||
| C | 0..1 | string | Unique id for supplementalData in measure + Warning: Link ids should be 255 characters or less | |
| 0..1 | CodeableConcept | Meaning of the supplemental data Binding: Measure Supplemental Data Example (Example) | ||
| 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: Measure Data Usage (Extensible) | ||
| 0..1 | markdown | The human readable description of this supplemental data | ||
| 1..1 | Expression | Expression describing additional data to be reported | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Results of a measure evaluation + Rule: Measure Reports used for data collection SHALL NOT communicate group and score information + Rule: Stratifiers SHALL be either a single criteria or a set of criteria components Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Additional identifier for the MeasureReport | |
| ?!Σ | 1..1 | code | complete | pending | error Binding: Measure Report Status (Required) | |
| ΣC | 1..1 | code | individual | subject-list | summary | data-exchange Binding: Measure Report Type (Required) | |
| ?!Σ | 0..1 | code | incremental | snapshot Binding: Submit Data Update Type (Required) | |
| Σ | 0..1 | canonical(Measure) | What measure was calculated | |
| Σ | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | What individual(s) the report is for | |
| Σ | 0..1 | dateTime | When the measure was calculated | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Group) | Who is reporting the data | |
| 0..1 | Reference(Organization) | What vendor prepared the data | ||
| 0..1 | Reference(Location) | Where the reported data is from | ||
| Σ | 1..1 | Period | What period the report covers | |
| 0..1 | Reference(Parameters) | What parameters were provided to the report | ||
| ?!Σ | 0..1 | CodeableConcept | What scoring method (e.g. proportion, ratio, continuous-variable) Binding: MeasureScoring (Extensible) | |
| ?!Σ | 0..1 | CodeableConcept | increase | decrease Binding: Measure Improvement Notation (Required) | |
| C | 0..* | BackboneElement | Measure results for each group | |
| 0..1 | string | Pointer to specific group from Measure | ||
| Σ | 0..1 | CodeableConcept | Meaning of the group Binding: Measure Group Example (Example) | |
| Σ | 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | What individual(s) the report is for | |
| 0..* | BackboneElement | The populations in the group | ||
| 0..1 | string | Pointer to specific population from Measure | ||
| Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Population Type (Extensible) | |
| 0..1 | integer | Size of the population | ||
| 0..1 | Reference(List) | For subject-list reports, the subject results in this population | ||
| 0..* | Reference(MeasureReport) | For subject-list reports, a subject result in this population | ||
| 0..1 | Reference(Group) | What individual(s) in the population | ||
| Σ | 0..1 | What score this group achieved | ||
| Quantity | ||||
| dateTime | ||||
| CodeableConcept | ||||
| Period | ||||
| Range | ||||
| Duration | ||||
| C | 0..* | BackboneElement | Stratification results | |
| 0..1 | string | Pointer to specific stratifier from Measure | ||
| 0..1 | CodeableConcept | What stratifier of the group Binding: Measure Stratifier Example (Example) | ||
| C | 0..* | BackboneElement | Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components | |
| C | 0..1 | The stratum value, e.g. male Binding: Measure Report Stratifier Value Example (Example) | ||
| CodeableConcept | ||||
| boolean | ||||
| Quantity | ||||
| Range | ||||
| Reference() | ||||
| C | 0..* | BackboneElement | Stratifier component values | |
| 0..1 | string | Pointer to specific stratifier component from Measure | ||
| 1..1 | CodeableConcept | What stratifier component of the group Binding: Measure Stratifier Example (Example) | ||
| 1..1 | The stratum component value, e.g. male Binding: Measure Report Stratifier Value Example (Example) | |||
| CodeableConcept | ||||
| boolean | ||||
| Quantity | ||||
| Range | ||||
| Reference() | ||||
| 0..* | BackboneElement | Population results in this stratum | ||
| 0..1 | string | Pointer to specific population from Measure | ||
| 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Population Type (Extensible) | ||
| 0..1 | integer | Size of the population | ||
| 0..1 | Reference(List) | For subject-list reports, the subject results in this population | ||
| 0..* | Reference(MeasureReport) | For subject-list reports, a subject result in this population | ||
| 0..1 | Reference(Group) | What individual(s) in the population | ||
| 0..1 | What score this stratum achieved | |||
| Quantity | ||||
| dateTime | ||||
| CodeableConcept | ||||
| Period | ||||
| Range | ||||
| Duration | ||||
| 0..* | Reference(Any) | Additional information collected for the report | ||
| 0..* | Reference(Any) | What data was used to calculate the measure score | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Definition of a Medication Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for this medication | |
| Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: SNOMED CT Medication Codes (Example) | |
| ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (Required) | |
| Σ | 0..1 | Reference(Organization) | Organization that has authorization to market medication | |
| 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMED CT Form Codes (Example) | ||
| Σ | 0..1 | Quantity | When the specified product code does not infer a package size, this is the specific amount of drug in the product | |
| 0..* | BackboneElement | Active or inactive ingredient | ||
| 1..1 | CodeableReference(Substance | Medication) | The ingredient (substance or medication) that the ingredient.strength relates to Binding: SNOMED CT Medication Codes (Example) | ||
| 0..1 | boolean | Active ingredient indicator | ||
| 0..1 | Quantity of ingredient present Binding: Medication Ingredient Strength Codes (Preferred) | |||
| Ratio | ||||
| CodeableConcept | ||||
| Quantity | ||||
| 0..1 | BackboneElement | Details about packaged medications | ||
| 0..1 | string | Identifier assigned to batch | ||
| 0..1 | dateTime | When batch will expire | ||
| 0..1 | Reference(MedicationKnowledge) | Knowledge about this medication | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Administration of medication to a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | External identifier | ||
| 0..* | Reference(CarePlan) | Plan this is fulfilled by this administration | ||
| Σ | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event | |
| ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (Required) | |
| 0..* | CodeableConcept | Reason administration not performed Binding: SNOMED CT Reason Medication Not Given Codes (Example) | ||
| 0..* | CodeableConcept | Type of medication administration Binding: MedicationAdministration Location Codes (Example) | ||
| Σ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMED CT Medication Codes (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Who received medication | |
| 0..1 | Reference(Encounter) | Encounter administered as part of | ||
| 0..* | Reference(Any) | Additional information to support administration | ||
| Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| Σ | 0..1 | dateTime | When the MedicationAdministration was first captured in the subject's record | |
| 0..1 | boolean | Full dose was not administered | ||
| 0..* | CodeableConcept | Reason full dose was not administered Binding: MedicationAdministration Subpotent Reason (Example) | ||
| Σ | 0..* | BackboneElement | Who or what performed the medication administration and what type of performance they did | |
| 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (Example) | ||
| Σ | 1..1 | CodeableReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who or what performed the medication administration | |
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered Binding: Reason Medication Given Codes (Example) | ||
| 0..1 | Reference(MedicationRequest) | Request administration performed against | ||
| 0..* | CodeableReference(Device) | Device used to administer | ||
| 0..* | Annotation | Information about the administration | ||
| C | 0..1 | BackboneElement | Details of how medication was taken + Rule: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] | |
| C | 0..1 | string | Free text dosage instructions e.g. SIG | |
| 0..1 | CodeableConcept | Body site administered to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (Example) | ||
| 0..1 | CodeableConcept | Path of substance into body Binding: SNOMED CT Route Codes (Example) | ||
| 0..1 | CodeableConcept | How drug was administered Binding: SNOMED CT Administration Method Codes (Example) | ||
| C | 0..1 | SimpleQuantity | Amount of medication per dose | |
| C | 0..1 | Dose quantity per unit of time | ||
| Ratio | ||||
| SimpleQuantity | ||||
| 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Dispensing a medication to a named patient + Rule: whenHandedOver cannot be before whenPrepared Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | External identifier | ||
| 0..* | Reference(CarePlan) | Plan that is fulfilled by this dispense | ||
| 0..* | Reference(Procedure | MedicationAdministration) | Event that dispense is part of | ||
| ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (Required) | |
| 0..1 | CodeableReference(DetectedIssue) | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (Example) | ||
| 0..1 | dateTime | When the status changed | ||
| 0..* | CodeableConcept | Type of medication dispense Binding: MedicationDispense Administration Location Codes (Example) | ||
| Σ | 1..1 | CodeableReference(Medication) | What medication was supplied Binding: SNOMED CT Medication Codes (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Who the dispense is for | |
| 0..1 | Reference(Encounter) | Encounter associated with event | ||
| 0..* | Reference(Any) | Information that supports the dispensing of the medication | ||
| 0..* | BackboneElement | Who performed event | ||
| 0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispense Performer Function Codes (Example) | ||
| 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | ||
| 0..1 | Reference(Location) | Where the dispense occurred | ||
| 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense | ||
| 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc Binding: ActPharmacySupplyType (Example) | ||
| 0..1 | SimpleQuantity | Amount dispensed | ||
| 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | ||
| 0..1 | dateTime | When the recording of the dispense started | ||
| ΣC | 0..1 | dateTime | When product was packaged and reviewed | |
| C | 0..1 | dateTime | When product was given out | |
| 0..1 | Reference(Location) | Where the medication was/will be sent | ||
| 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered | ||
| 0..* | Annotation | Information about the dispense | ||
| 0..1 | markdown | Full representation of the dosage instructions | ||
| 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||
| 0..1 | BackboneElement | Whether a substitution was performed on the dispense | ||
| 1..1 | boolean | Whether a substitution was or was not performed on the dispense | ||
| 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (Example) | ||
| 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the substitution | ||
| 0..* | Reference(Provenance) | A list of relevant lifecycle events | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Definition of Medication Knowledge Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| Σ | 0..* | Identifier | Business identifier for this medication | |
| Σ | 0..1 | CodeableConcept | Code that identifies this medication Binding: SNOMED CT Medication Codes (Example) | |
| ?!Σ | 0..1 | code | active | entered-in-error | inactive Binding: MedicationKnowledge Status Codes (Required) | |
| 0..1 | Reference(Organization) | Creator or owner of the knowledge or information about the medication | ||
| 0..* | CodeableConcept | Codes that identify the different jurisdictions for which the information of this resource was created | ||
| Σ | 0..* | string | A name associated with the medication being described | |
| 0..* | BackboneElement | Associated or related medication information | ||
| 1..1 | CodeableConcept | Category of medicationKnowledge | ||
| 1..* | Reference(MedicationKnowledge) | Associated documentation about the associated medication knowledge | ||
| 0..* | Reference(Medication) | The set of medication resources that are associated with this medication | ||
| 0..* | CodeableConcept | Category of the medication or product | ||
| 0..* | BackboneElement | Associated documentation about the medication | ||
| 0..1 | CodeableConcept | The category of medication document | ||
| 0..1 | Reference(DocumentReference) | Associated documentation about the medication | ||
| 0..1 | markdown | The instructions for preparing the medication | ||
| 0..* | BackboneElement | The pricing of the medication | ||
| 0..* | Period | The date range for which the cost is effective | ||
| 1..1 | CodeableConcept | The category of the cost information | ||
| 0..1 | string | The source or owner for the price information | ||
| 1..1 | The price or category of the cost of the medication Binding: Medication Cost Category Codes (Example) | |||
| Money | ||||
| CodeableConcept | ||||
| Σ | 0..* | BackboneElement | Program under which a medication is reviewed | |
| 0..1 | CodeableConcept | Type of program under which the medication is monitored | ||
| 0..1 | string | Name of the reviewing program | ||
| 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication | ||
| 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline | ||
| 0..* | BackboneElement | Guidelines for dosage of the medication | ||
| 0..1 | CodeableConcept | Intention of the treatment | ||
| 0..* | BackboneElement | Dosage for the medication for the specific guidelines | ||
| 1..1 | CodeableConcept | Category of dosage for a medication | ||
| 1..* | Dosage | Dosage for the medication for the specific guidelines | ||
| 0..1 | CodeableConcept | Type of treatment the guideline applies to | ||
| 0..* | BackboneElement | Characteristics of the patient that are relevant to the administration guidelines | ||
| 1..1 | CodeableConcept | Categorization of specific characteristic that is relevant to the administration guideline | ||
| 0..1 | The specific characteristic | |||
| CodeableConcept | ||||
| Quantity | ||||
| Range | ||||
| 0..* | BackboneElement | Categorization of the medication within a formulary or classification system | ||
| 1..1 | CodeableConcept | The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) | ||
| 0..1 | The source of the classification | |||
| string | ||||
| uri | ||||
| 0..* | CodeableConcept | Specific category assigned to the medication | ||
| 0..* | BackboneElement | Details about packaged medications | ||
| 0..* | see cost | Cost of the packaged medication | ||
| 0..1 | Reference(PackagedProductDefinition) | The packaged medication that is being priced | ||
| 0..* | Reference(ClinicalUseDefinition) | Potential clinical issue with or between medication(s) | ||
| 0..* | BackboneElement | How the medication should be stored | ||
| 0..1 | uri | Reference to additional information | ||
| 0..* | Annotation | Additional storage notes | ||
| 0..1 | Duration | Duration remains stable | ||
| 0..* | BackboneElement | Setting or value of environment for adequate storage | ||
| 1..1 | CodeableConcept | Categorization of the setting | ||
| 1..1 | Value of the setting | |||
| Quantity | ||||
| Range | ||||
| CodeableConcept | ||||
| 0..* | BackboneElement | Regulatory information about a medication | ||
| 1..1 | Reference(Organization) | Specifies the authority of the regulation | ||
| 0..* | BackboneElement | Specifies if changes are allowed when dispensing a medication from a regulatory perspective | ||
| 1..1 | CodeableConcept | Specifies the type of substitution allowed | ||
| 1..1 | boolean | Specifies if regulation allows for changes in the medication when dispensing | ||
| 0..* | CodeableConcept | Specifies the schedule of a medication in jurisdiction | ||
| 0..1 | BackboneElement | The maximum number of units of the medication that can be dispensed in a period | ||
| 1..1 | SimpleQuantity | The maximum number of units of the medication that can be dispensed | ||
| 0..1 | Duration | The period that applies to the maximum number of units | ||
| 0..1 | BackboneElement | Minimal definition information about the medication | ||
| 0..* | Reference(MedicinalProductDefinition) | Definitional resources that provide more information about this medication | ||
| 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMED CT Form Codes (Example) | ||
| 0..* | CodeableConcept | The intended or approved route of administration Binding: SNOMED CT Route Codes (Example) | ||
| Σ | 0..* | BackboneElement | Active or inactive ingredient | |
| Σ | 1..1 | CodeableReference(Substance) | Substances contained in the medication | |
| 0..1 | CodeableConcept | A code that defines the type of ingredient, active, base, etc Binding: RoleClassIngredientEntity (Example) | ||
| 0..1 | Quantity of ingredient present Binding: Medication Ingredient Strength Codes (Example) | |||
| Ratio | ||||
| CodeableConcept | ||||
| Quantity | ||||
| 0..* | BackboneElement | Specifies descriptive properties of the medicine | ||
| 0..1 | CodeableConcept | Code specifying the type of characteristic of medication Binding: medicationKnowledge Characteristic Codes (Example) | ||
| 0..1 | Description of the characteristic | |||
| CodeableConcept | ||||
| string | ||||
| SimpleQuantity | ||||
| base64Binary | ||||
| Attachment | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Ordering of medication for patient or group Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | External ids for this request | ||
| Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | A plan or request that is fulfilled in whole or in part by this medication request | |
| 0..1 | Reference(MedicationRequest) | Reference to an order/prescription that is being replaced by this MedicationRequest | ||
| Σ | 0..1 | Identifier | Composite request this is part of | |
| ?!Σ | 1..1 | code | active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown Binding: medicationrequest Status (Required) | |
| 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (Example) | ||
| 0..1 | dateTime | When the status was changed | ||
| ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (Required) | |
| 0..* | CodeableConcept | Grouping or category of medication request Binding: medicationRequest Administration Location Codes (Example) | ||
| Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | |
| ?!Σ | 0..1 | boolean | True if patient is to stop taking or not to start taking the medication | |
| Σ | 1..1 | CodeableReference(Medication) | Medication to be taken Binding: SNOMED CT Medication Codes (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Individual or group for whom the medication has been requested | |
| 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | The person or organization who provided the information about this request, if the source is someone other than the requestor | ||
| 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | ||
| 0..* | Reference(Any) | Information to support fulfilling of the medication | ||
| Σ | 0..1 | dateTime | When request was initially authored | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request | |
| Σ | 0..1 | boolean | Reported rather than primary record | |
| Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: Medication Intended Performer Role (Extensible) | |
| 0..* | Reference(Practitioner | PractitionerRole | Organization | Patient | DeviceDefinition | RelatedPerson | CareTeam | HealthcareService) | Intended performer of administration | ||
| 0..* | CodeableReference(DeviceDefinition) | Intended type of device for the administration | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | ||
| 0..* | CodeableReference(Condition | Observation) | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/Diagnosis Codes (Example) | ||
| 0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (Extensible) | ||
| 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||
| 0..* | Annotation | Information about the prescription | ||
| 0..1 | markdown | Full representation of the dosage instructions | ||
| 0..1 | Period | Period over which the medication is to be taken | ||
| 0..* | Dosage | Specific instructions for how the medication should be taken | ||
| 0..1 | BackboneElement | Medication supply authorization | ||
| 0..1 | BackboneElement | First fill details | ||
| 0..1 | SimpleQuantity | First fill quantity | ||
| 0..1 | Duration | First fill duration | ||
| 0..1 | Duration | Minimum period of time between dispenses | ||
| 0..1 | Period | Time period supply is authorized for | ||
| 0..1 | unsignedInt | Number of refills authorized | ||
| 0..1 | SimpleQuantity | Amount of medication to supply per dispense | ||
| 0..1 | Duration | Number of days supply per dispense | ||
| 0..1 | Reference(Organization) | Intended performer of dispense | ||
| 0..* | Annotation | Additional information for the dispenser | ||
| 0..1 | CodeableConcept | Type of adherence packaging to use for the dispense Binding: Medication Dose Aids (Example) | ||
| 0..1 | BackboneElement | Any restrictions on medication substitution | ||
| 1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (Preferred) | |||
| boolean | ||||
| CodeableConcept | ||||
| 0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (Example) | ||
| TU | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Record of medication being taken by a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External identifier | |
| 0..* | Reference(Procedure | MedicationStatement) | Part of referenced event | ||
| ?!Σ | 1..1 | code | recorded | entered-in-error | draft Binding: MedicationStatement Status Codes (Required) | |
| Σ | 0..* | CodeableConcept | Type of medication statement Binding: medicationRequest Administration Location Codes (Example) | |
| Σ | 1..1 | CodeableReference(Medication) | What medication was taken Binding: SNOMED CT Medication Codes (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication | |
| Σ | 0..1 | Reference(Encounter) | Encounter associated with MedicationStatement | |
| Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| Σ | 0..1 | dateTime | When the usage was asserted? | |
| 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | ||
| 0..* | Reference(Any) | Link to information used to derive the MedicationStatement | ||
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Reason for why the medication is being/was taken Binding: Condition/Problem/Diagnosis Codes (Example) | ||
| 0..* | Annotation | Further information about the usage | ||
| 0..* | Reference(Observation | Condition) | Link to information relevant to the usage of a medication | ||
| 0..1 | markdown | Full representation of the dosage instructions | ||
| 0..* | Dosage | Details of how medication is/was taken or should be taken | ||
| Σ | 0..1 | BackboneElement | Indicates whether the medication is or is not being consumed or administered | |
| Σ | 1..1 | CodeableConcept | Type of adherence Binding: MedicationStatement Adherence Codes (Example) | |
| 0..1 | CodeableConcept | Details of the reason for the current use of the medication Binding: SNOMED CT Drug Therapy Status codes (Example) | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | Detailed definition of a medicinal product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | Business identifier for this product. Could be an MPID | |||||
| Σ | 0..1 | CodeableConcept | Regulatory type, e.g. Investigational or Authorized Binding: Medicinal Product Type (Example) | |||||
| Σ | 0..1 | CodeableConcept | If this medicine applies to human or veterinary uses Binding: Medicinal Product Domain (Example) | |||||
| Σ | 0..1 | string | A business identifier relating to a specific version of the product | |||||
| ?!Σ | 0..1 | CodeableConcept | The status within the lifecycle of this product record Binding: PublicationStatus (Preferred) | |||||
| Σ | 0..1 | dateTime | The date at which the given status became applicable | |||||
| Σ | 0..1 | markdown | General description of this product | |||||
| Σ | 0..1 | CodeableConcept | The dose form for a single part product, or combined form of a multiple part product Binding: Combined Dose Form (Example) | |||||
| Σ | 0..* | CodeableConcept | The path by which the product is taken into or makes contact with the body Binding: SNOMED CT Route Codes (Example) | |||||
| Σ | 0..1 | markdown | Description of indication(s) for this product, used when structured indications are not required | |||||
| Σ | 0..1 | CodeableConcept | The legal status of supply of the medicinal product as classified by the regulator Binding: Legal Status Of Supply (Example) | |||||
| Σ | 0..1 | CodeableConcept | Whether the Medicinal Product is subject to additional monitoring for regulatory reasons Binding: Additional Monitoring (Example) | |||||
| Σ | 0..* | CodeableConcept | Whether the Medicinal Product is subject to special measures for regulatory reasons Binding: Special Measures (Example) | |||||
| Σ | 0..1 | CodeableConcept | If authorised for use in children Binding: Pediatric Use (Example) | |||||
| Σ | 0..* | CodeableConcept | Allows the product to be classified by various systems Binding: Product Classification (Example) | |||||
| Σ | 0..* | MarketingStatus | Marketing status of the medicinal product, in contrast to marketing authorization | |||||
| Σ | 0..* | CodeableConcept | Package type for the product Binding: Medicinal Product Package Type (Example) | |||||
| Σ | 0..* | Reference(ManufacturedItemDefinition | DeviceDefinition) | Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes | |||||
| Σ | 0..* | CodeableConcept | The ingredients of this medicinal product - when not detailed in other resources Binding: SNOMED CT Substance Codes (Example) | |||||
| Σ | 0..* | CodeableReference(SubstanceDefinition) | Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product Binding: SNOMED CT Substance Codes (Example) | |||||
| Σ | 0..* | Reference(DocumentReference) | Additional documentation about the medicinal product | |||||
| Σ | 0..* | Reference(DocumentReference) | A master file for the medicinal product (e.g. Pharmacovigilance System Master File) | |||||
| Σ | 0..* | BackboneElement | A product specific contact, person (in a role), or an organization | |||||
| Σ | 0..1 | CodeableConcept | Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information Binding: Product Contact Type (Example) | |||||
| Σ | 1..1 | Reference(Organization | PractitionerRole) | A product specific contact, person (in a role), or an organization | |||||
| Σ | 0..* | Reference(ResearchStudy) | Clinical trials or studies that this product is involved in | |||||
| Σ | 0..* | Coding | A code that this product is known by, within some formal terminology Binding: SNOMED CT Medication Codes (Example) | |||||
| Σ | 1..* | BackboneElement | The product's name, including full name and possibly coded parts | |||||
| Σ | 1..1 | string | The full product name | |||||
| Σ | 0..1 | CodeableConcept | Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary Binding: Product Name Type (Example) | |||||
| Σ | 0..* | BackboneElement | Coding words or phrases of the name | |||||
| Σ | 1..1 | string | A fragment of a product name | |||||
| Σ | 1..1 | CodeableConcept | Identifying type for this part of the name (e.g. strength part) Binding: Product Name Part Type (Example) | |||||
| Σ | 0..* | BackboneElement | Country and jurisdiction where the name applies | |||||
| Σ | 1..1 | CodeableConcept | Country code for where this name applies Binding: Country ValueSet (Example) | |||||
| Σ | 0..1 | CodeableConcept | Jurisdiction code for where this name applies Binding: Jurisdiction ValueSet (Example) | |||||
| Σ | 1..1 | CodeableConcept | Language code for this name Binding: All Languages (Required)
| |||||
| Σ | 0..* | BackboneElement | Reference to another product, e.g. for linking authorised to investigational product | |||||
| Σ | 1..1 | CodeableReference(MedicinalProductDefinition) | Reference to another product, e.g. for linking authorised to investigational product | |||||
| Σ | 0..1 | CodeableConcept | The type of relationship, for instance branded to generic or virtual to actual product Binding: Product Cross Reference Type (Example) | |||||
| Σ | 0..* | BackboneElement | A manufacturing or administrative process for the medicinal product | |||||
| Σ | 0..1 | CodeableReference(ActivityDefinition | PlanDefinition) | The type of manufacturing operation e.g. manufacturing itself, re-packaging | |||||
| Σ | 0..1 | Period | Date range of applicability | |||||
| Σ | 0..* | Reference(Organization) | The organization responsible for the particular process, e.g. the manufacturer or importer | |||||
| Σ | 0..1 | CodeableConcept | Specifies whether this process is considered proprietary or confidential Binding: Product Confidentiality (Example) | |||||
| Σ | 0..* | BackboneElement | Key product features such as "sugar free", "modified release" | |||||
| Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: Product Characteristic (Example) | |||||
| Σ | 0..1 | A value for the characteristic | ||||||
| CodeableConcept | ||||||||
| markdown | ||||||||
| Quantity | ||||||||
| integer | ||||||||
| date | ||||||||
| boolean | ||||||||
| Attachment | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A resource that defines a type of message that can be exchanged between systems + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 0..1 | uri | The cannonical URL for a given MessageDefinition + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Business Identifier for a given MessageDefinition | |
| Σ | 0..1 | string | Business version of the message definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this message definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this message definition (human friendly) | |
| Σ | 0..* | canonical(MessageDefinition) | Takes the place of | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 1..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the message definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| ΣT | 0..1 | markdown | Why this message definition is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | |
| Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | |
| Σ | 1..1 | Event code or link to the EventDefinition Binding: MessageEvent (Example) | ||
| Coding | ||||
| uri | ||||
| Σ | 0..1 | code | consequence | currency | notification Binding: Message Significance Category (Required) | |
| ΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event + Rule: Max must be postive int or * | |
| Σ | 1..1 | code | Type of resource Binding: Resource Types (Required) | |
| 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | ||
| Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | |
| C | 0..1 | string | Maximum number of focuses of this type | |
| 0..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (Required) | ||
| 0..* | BackboneElement | Responses to this message | ||
| 1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | ||
| 0..1 | markdown | When should this response be used | ||
| 0..1 | canonical(GraphDefinition) | Canonical reference to a GraphDefinition | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A resource that describes a message that is exchanged between systems Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 1..1 | Event code or link to EventDefinition Binding: MessageEvent (Example) | ||
| Coding | ||||
| canonical(EventDefinition) | ||||
| Σ | 0..* | BackboneElement | Message destination application(s) | |
| Σ | 0..1 | Actual destination address or Endpoint resource | ||
| url | ||||
| Reference(Endpoint) | ||||
| Σ | 0..1 | string | Name of system | |
| Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | Real world sender of the message | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | The source of the decision | |
| Σ | 1..1 | BackboneElement | Message source application | |
| Σ | 0..1 | Actual source address or Endpoint resource | ||
| url | ||||
| Reference(Endpoint) | ||||
| Σ | 0..1 | string | Name of system | |
| Σ | 0..1 | string | Name of software running the system | |
| Σ | 0..1 | string | Version of software running | |
| Σ | 0..1 | ContactPoint | Human contact for problems | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | |
| Σ | 0..1 | CodeableConcept | Cause of event Binding: Example Message Reason Codes (Example) | |
| Σ | 0..1 | BackboneElement | If this is a reply to prior message | |
| Σ | 1..1 | Identifier | Bundle.identifier of original message | |
| Σ | 1..1 | code | ok | transient-error | fatal-error Binding: Response Type (Required) | |
| Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | |
| Σ | 0..* | Reference(Any) | The actual content of the message | |
| Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| «I»N | CanonicalResource | Common Interface declaration for definitional resources Elements defined in Ancestor Resources: id, meta, implicitRules, language, text, contained, extension, modifierExtension Elements defined in Ancestor interfaces: url, identifier, version, versionAlgorithm[x], name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, copyrightLabel | ||
| 0..1 | date | When the {{title}} was approved by publisher | ||
| 0..1 | date | When the {{title}} was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the {{title}} is expected to be used | |
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the {{title}} | ||
| 0..* | ContactDetail | Who edited the {{title}} | ||
| 0..* | ContactDetail | Who reviewed the {{title}} | ||
| 0..* | ContactDetail | Who endorsed the {{title}} | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Representation of a molecular sequence Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique ID for this particular sequence | |
| Σ | 0..1 | code | aa | dna | rna Binding: sequence Type (Required) | |
| Σ | 0..1 | Reference(Patient | Group | Substance | BiologicallyDerivedProduct | NutritionProduct) | Subject this sequence is associated too | |
| Σ | 0..* | Reference(Any) | What the molecular sequence is about, when it is not about the subject of record | |
| Σ | 0..1 | Reference(Specimen) | Specimen used for sequencing | |
| Σ | 0..1 | Reference(Device) | The method for sequencing | |
| Σ | 0..1 | Reference(Organization) | Who should be responsible for test result | |
| Σ | 0..1 | string | Sequence that was observed | |
| Σ | 0..* | Attachment | Embedded file or a link (URL) which contains content to represent the sequence | |
| Σ | 0..* | BackboneElement | A sequence defined relative to another sequence | |
| Σ | 1..1 | CodeableConcept | Ways of identifying nucleotides or amino acids within a sequence Binding: LL5323-2 (Extensible) | |
| 0..1 | integer | Indicates the order in which the sequence should be considered when putting multiple 'relative' elements together | ||
| 0..1 | Range | Indicates the nucleotide range in the composed sequence when multiple 'relative' elements are used together | ||
| ΣC | 0..1 | BackboneElement | A sequence used as starting sequence + Rule: Both genomeAssembly and chromosome must be both contained if either one of them is contained + Rule: Have and only have one of the following elements in startingSequence: 1. genomeAssembly; 2 sequence | |
| ΣC | 0..1 | CodeableConcept | The genome assembly used for starting sequence, e.g. GRCh38 Binding: LL1040-6 (Extensible) | |
| ΣC | 0..1 | CodeableConcept | Chromosome Identifier Binding: LL2938-0 (Required) | |
| ΣC | 0..1 | The reference sequence that represents the starting sequence Binding: Multiple bindings acceptable (NCBI or LRG) (Example) | ||
| CodeableConcept | ||||
| string | ||||
| Reference(MolecularSequence) | ||||
| Σ | 0..1 | integer | Start position of the window on the starting sequence | |
| Σ | 0..1 | integer | End position of the window on the starting sequence | |
| Σ | 0..1 | code | sense | antisense Binding: orientation Type (Required) | |
| Σ | 0..1 | code | watson | crick Binding: strand Type (Required) | |
| Σ | 0..* | BackboneElement | Changes in sequence from the starting sequence | |
| Σ | 0..1 | integer | Start position of the edit on the starting sequence | |
| Σ | 0..1 | integer | End position of the edit on the starting sequence | |
| Σ | 0..1 | string | Allele that was observed | |
| Σ | 0..1 | string | Allele in the starting sequence | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | System of unique identification + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Root systems cannot have uuid identifiers + Rule: Can't have more than one preferred identifier for a type + Rule: Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this naming system, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the naming system (business identifier) | |
| Σ | 0..1 | string | Business version of the naming system | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 1..1 | string | Name for this naming system (computer friendly) | |
| ΣT | 0..1 | string | Title for this naming system (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| ΣC | 1..1 | code | codesystem | identifier | root Binding: Naming System Type (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 1..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | string | Who maintains system namespace? | |
| 0..1 | CodeableConcept | e.g. driver, provider, patient, bank etc Binding: Naming System Identifier System Type (Preferred) | ||
| T | 0..1 | markdown | Natural language description of the naming system | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for naming system (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this naming system is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the NamingSystem was approved by publisher | ||
| 0..1 | date | When the NamingSystem was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the NamingSystem is expected to be used | |
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the CodeSystem | ||
| 0..* | ContactDetail | Who edited the NamingSystem | ||
| 0..* | ContactDetail | Who reviewed the NamingSystem | ||
| 0..* | ContactDetail | Who endorsed the NamingSystem | ||
| 0..* | RelatedArtifact | Additional documentation, citations, etc | ||
| T | 0..1 | string | How/where is it used | |
| ΣC | 1..* | BackboneElement | Unique identifiers used for system | |
| ΣC | 1..1 | code | oid | uuid | uri | iri-stem | v2csmnemonic | other Binding: Naming System Identifier Type (Required) | |
| Σ | 1..1 | string | The unique identifier | |
| C | 0..1 | boolean | Is this the id that should be used for this type | |
| 0..1 | string | Notes about identifier usage | ||
| C | 0..1 | Period | When is identifier valid? | |
| C | 0..1 | boolean | Whether the identifier is authoritative | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Record of food or fluid being taken by a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External identifier | |
| 0..* | canonical(Definition) | Instantiates FHIR protocol or definition | ||
| 0..* | uri | Instantiates external protocol or definition | ||
| Σ | 0..* | Reference(NutritionOrder | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | |
| Σ | 0..* | Reference(NutritionIntake | Procedure | Observation) | Part of referenced event | |
| ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (Required) | |
| 0..* | CodeableConcept | Reason for current status Binding: ClinicalImpression Status Reason (Example) | ||
| Σ | 0..1 | CodeableConcept | Code representing an overall type of nutrition intake Binding: Diet Codes (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Who is/was consuming the food or fluid | |
| Σ | 0..1 | Reference(Encounter) | Encounter associated with NutritionIntake | |
| Σ | 0..1 | The date/time or interval when the food or fluid is/was consumed | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | dateTime | When the intake was recorded | |
| 0..1 | Person or organization that provided the information about the consumption of this food or fluid | |||
| boolean | ||||
| Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | ||||
| 1..* | BackboneElement | What food or fluid product or item was consumed | ||
| Σ | 1..1 | CodeableConcept | The type of food or fluid product Binding: Types of Edible Substances (Example) | |
| Σ | 1..1 | CodeableReference(NutritionProduct) | Code that identifies the food or fluid product that was consumed Binding: Food Type Codes (Example) | |
| 0..1 | Timing | Scheduled frequency of consumption | ||
| Σ | 0..1 | SimpleQuantity | Quantity of the specified food | |
| Σ | 0..1 | SimpleQuantity | Rate at which enteral feeding was administered | |
| 0..1 | boolean | Flag to indicate if the food or fluid item was refused or otherwise not consumed | ||
| 0..1 | CodeableConcept | Reason food or fluid was not consumed Binding: Reasons for why a food item was not consumed (Example) | ||
| 0..* | BackboneElement | Total nutrient for the whole meal, product, serving | ||
| 1..1 | CodeableReference(Substance) | Total nutrient consumed Binding: Nutrient Modifier Codes (Example) | ||
| 1..1 | SimpleQuantity | Total amount of nutrient consumed | ||
| 0..* | BackboneElement | Who was performed in the intake | ||
| 0..1 | CodeableConcept | Type of performer Binding: Procedure Performer Role Codes (Example) | ||
| 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Who performed the intake | ||
| 0..1 | Reference(Location) | Where the intake occurred | ||
| 0..* | Reference(Any) | Additional supporting information | ||
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Reason for why the food or fluid is /was consumed Binding: Condition/Problem/Diagnosis Codes (Example) | ||
| 0..* | Annotation | Further information about the consumption | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Diet, formula or nutritional supplement request + Warning: Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Identifiers assigned to this order | ||
| Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| 0..* | uri | Instantiates protocol or definition | ||
| 0..* | Reference(CarePlan | NutritionOrder | ServiceRequest) | What this order fulfills | ||
| Σ | 0..1 | Identifier | Composite Request ID | |
| ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (Required) | |
| ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (Required) | |
| 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | ||
| Σ | 1..1 | Reference(Patient | Group) | Who requires the diet, formula or nutritional supplement | |
| 0..1 | Reference(Encounter) | The encounter associated with this nutrition order | ||
| 0..* | Reference(Any) | Information to support fulfilling of the nutrition order | ||
| Σ | 1..1 | dateTime | Date and time the nutrition order was requested | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who ordered the diet, formula or nutritional supplement | |
| 0..* | CodeableReference(CareTeam | Practitioner | PractitionerRole | RelatedPerson | Patient | Organization) | Who is desired to perform the administration of what is being ordered | ||
| 0..* | Reference(AllergyIntolerance) | List of the patient's food and nutrition-related allergies and intolerances | ||
| 0..* | CodeableConcept | Order-specific modifier about the type of food that should be given Binding: Diet (Example) | ||
| 0..* | CodeableConcept | Order-specific modifier about the type of food that should not be given Binding: Food Type Codes (Example) | ||
| 0..1 | boolean | Capture when a food item is brought in by the patient and/or family | ||
| C | 0..1 | BackboneElement | Oral diet components | |
| Σ | 0..* | CodeableConcept | Type of oral diet or diet restrictions that describe what can be consumed orally Binding: Diet Codes (Example) | |
| 0..1 | BackboneElement | Scheduling information for oral diets | ||
| 0..* | Timing | Scheduled frequency of diet | ||
| 0..1 | boolean | Take 'as needed' | ||
| 0..1 | CodeableConcept | Take 'as needed' for x Binding: SNOMED CT Medication As Needed Reason Codes (Example) | ||
| 0..* | BackboneElement | Required nutrient modifications | ||
| 0..1 | CodeableConcept | Type of nutrient that is being modified Binding: Nutrient Modifier Codes (Example) | ||
| 0..1 | SimpleQuantity | Quantity of the specified nutrient | ||
| 0..* | BackboneElement | Required texture modifications | ||
| 0..1 | CodeableConcept | Code to indicate how to alter the texture of the foods, e.g. pureed Binding: Texture Modifier Codes (Example) | ||
| 0..1 | CodeableConcept | Concepts that are used to identify an entity that is ingested for nutritional purposes Binding: Texture Modified Food Type Codes (Example) | ||
| 0..* | CodeableConcept | The required consistency of fluids and liquids provided to the patient Binding: Fluid Consistency Type Codes (Example) | ||
| Σ | 0..1 | string | Instructions or additional information about the oral diet | |
| C | 0..* | BackboneElement | Supplement components | |
| Σ | 0..1 | CodeableReference(NutritionProduct) | Type of supplement product requested Binding: Supplement Type Codes (Example) | |
| 0..1 | string | Product or brand name of the nutritional supplement | ||
| 0..1 | BackboneElement | Scheduling information for supplements | ||
| 0..* | Timing | Scheduled frequency of diet | ||
| 0..1 | boolean | Take 'as needed' | ||
| 0..1 | CodeableConcept | Take 'as needed' for x Binding: SNOMED CT Medication As Needed Reason Codes (Example) | ||
| 0..1 | SimpleQuantity | Amount of the nutritional supplement | ||
| Σ | 0..1 | string | Instructions or additional information about the oral supplement | |
| C | 0..1 | BackboneElement | Enteral formula components | |
| Σ | 0..1 | CodeableReference(NutritionProduct) | Type of enteral or infant formula Binding: Enteral Formula Type Codes (Example) | |
| 0..1 | string | Product or brand name of the enteral or infant formula | ||
| 0..* | CodeableReference(DeviceDefinition) | Intended type of device for the administration | ||
| 0..* | BackboneElement | Components to add to the feeding | ||
| 0..1 | CodeableReference(NutritionProduct) | Type of modular component to add to the feeding Binding: Enteral Formula Additive Type Code (Example) | ||
| 0..1 | string | Product or brand name of the modular additive | ||
| 0..1 | SimpleQuantity | Amount of additive to be given or mixed in | ||
| 0..1 | SimpleQuantity | Amount of energy per specified volume that is required | ||
| 0..1 | CodeableConcept | How the formula should enter the patient's gastrointestinal tract Binding: Enteral Route Codes (Extensible) | ||
| 0..* | BackboneElement | Formula feeding instruction as structured data | ||
| 0..1 | BackboneElement | Scheduling information for enteral formula products | ||
| 0..* | Timing | Scheduled frequency of enteral formula | ||
| 0..1 | boolean | Take 'as needed' | ||
| 0..1 | CodeableConcept | Take 'as needed' for x Binding: SNOMED CT Medication As Needed Reason Codes (Example) | ||
| 0..1 | SimpleQuantity | The volume of formula to provide | ||
| 0..1 | Speed with which the formula is provided per period of time | |||
| SimpleQuantity | ||||
| Ratio | ||||
| 0..1 | SimpleQuantity | Upper limit on formula volume per unit of time | ||
| Σ | 0..1 | markdown | Formula feeding instructions expressed as text | |
| 0..* | Annotation | Comments | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A product used for nutritional purposes (i.e. food or supplement) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | CodeableConcept | A code that can identify the detailed nutrients and ingredients in a specific food product Binding: Types of Edible Substances (Example) | |
| ?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: Nutrition Product Status (Required) | |
| Σ | 0..* | CodeableConcept | Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products Binding: Categories of Nutrition Products (Example) | |
| Σ | 0..* | Reference(Organization) | Manufacturer, representative or officially responsible for the product | |
| Σ | 0..* | BackboneElement | The product's nutritional information expressed by the nutrients | |
| 0..1 | CodeableReference(Substance) | The (relevant) nutrients in the product Binding: Codes for Nutrition Product Nutrients (Example) | ||
| 0..* | Ratio | The amount of nutrient expressed in one or more units: X per pack / per serving / per dose | ||
| 0..* | BackboneElement | Ingredients contained in this product | ||
| Σ | 1..1 | CodeableReference(NutritionProduct) | The ingredient contained in the product | |
| Σ | 0..* | Ratio | The amount of ingredient that is in the product | |
| 0..* | CodeableReference(Substance) | Known or suspected allergens that are a part of this product Binding: Codes for Allergen Classes (Example) | ||
| 0..* | BackboneElement | Specifies descriptive properties of the nutrition product | ||
| 1..1 | CodeableConcept | Code specifying the type of characteristic Binding: Codes for Product Characteristics (Example) | ||
| 1..1 | The value of the characteristic | |||
| CodeableConcept | ||||
| string | ||||
| SimpleQuantity | ||||
| base64Binary | ||||
| Attachment | ||||
| boolean | ||||
| 0..* | BackboneElement | One or several physical instances or occurrences of the nutrition product | ||
| 0..1 | SimpleQuantity | The amount of items or instances | ||
| 0..* | Identifier | The identifier for the physical instance, typically a serial number or manufacturer number | ||
| 0..1 | string | The name for the specific product | ||
| 0..1 | string | The identification of the batch or lot of the product | ||
| 0..1 | dateTime | The expiry date or date and time for the product | ||
| 0..1 | dateTime | The date until which the product is expected to be good for consumption | ||
| 0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | ||
| 0..* | Annotation | Comments made about the product | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| N | DomainResource | Measurements and simple assertions + Rule: dataAbsentReason SHALL only be present if Observation.value[x] is not present + Rule: If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). + Rule: bodyStructure SHALL only be present if Observation.bodySite is not present Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business Identifier for observation | |
| ΣTU | 0..1 | Instantiates FHIR ObservationDefinition | ||
| canonical(ObservationDefinition) | ||||
| Reference(ObservationDefinition) | ||||
| Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |
| TU | 0..* | BackboneElement | Triggering observation(s) | |
| Σ | 1..1 | Reference(Observation) | Triggering observation | |
| Σ | 1..1 | code | reflex | repeat | re-run Binding: triggered Bytype (Required) | |
| 0..1 | string | Reason that the observation was triggered | ||
| Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy | GenomicStudy) | Part of referenced event | |
| ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: Observation Status (Required) | |
| 0..* | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (Preferred) | ||
| ΣC | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (Example) | |
| Σ | 0..1 | Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct) | Who and/or what the observation is about | |
| ΣTU | 0..* | Reference(Any) | What the observation is about, when it is not about the subject of record | |
| Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
| Σ | 0..1 | Clinically relevant time/time-period for observation | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| instant | ||||
| Σ | 0..1 | instant | Date/Time this version was made available | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |
| ΣC | 0..1 | Actual result | ||
| Quantity | ||||
| CodeableConcept | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| Range | ||||
| Ratio | ||||
| SampledData | ||||
| time | ||||
| dateTime | ||||
| Period | ||||
| Attachment | ||||
| Reference(MolecularSequence) | ||||
| C | 0..1 | CodeableConcept | Why the result is missing Binding: Data Absent Reason (Extensible) | |
| 0..* | CodeableConcept | High, low, normal, etc Binding: Observation Interpretation Codes (Extensible) | ||
| 0..* | Annotation | Comments about the observation | ||
| C | 0..1 | CodeableConcept | Observed body part Binding: SNOMED CT Body Structures (Example) | |
| CTU | 0..1 | Reference(BodyStructure) | Observed body structure | |
| 0..1 | CodeableConcept | How it was done Binding: Observation Methods (Example) | ||
| C | 0..1 | Reference(Specimen | Group) | Specimen used for this observation + Rule: If Observation.specimen is a reference to Group, the group can only have specimens | |
| 0..1 | Reference(Device | DeviceMetric) | A reference to the device that generates the measurements or the device settings for the device | ||
| C | 0..* | BackboneElement | Provides guide for interpretation + Rule: Must have at least a low or a high or text | |
| C | 0..1 | SimpleQuantity | Low Range, if relevant | |
| C | 0..1 | SimpleQuantity | High Range, if relevant | |
| TU | 0..1 | CodeableConcept | Normal value, if relevant Binding: Observation Reference Range Normal Value Codes (Extensible) | |
| TU | 0..1 | CodeableConcept | Reference range qualifier Binding: Observation Reference Range Meaning Codes (Preferred) | |
| 0..* | CodeableConcept | Reference range population Binding: Observation Reference Range Applies To Codes (Example) | ||
| 0..1 | Range | Applicable age range, if relevant | ||
| C | 0..1 | markdown | Text based reference range in an observation | |
| Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |
| Σ | 0..* | Reference(DocumentReference | ImagingStudy | ImagingSelection | QuestionnaireResponse | Observation | MolecularSequence | GenomicStudy) | Related resource from which the observation is made | |
| ΣC | 0..* | BackboneElement | Component results | |
| ΣC | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (Example) | |
| Σ | 0..1 | Actual component result | ||
| Quantity | ||||
| CodeableConcept | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| Range | ||||
| Ratio | ||||
| SampledData | ||||
| time | ||||
| dateTime | ||||
| Period | ||||
| Attachment | ||||
| Reference(MolecularSequence) | ||||
| 0..1 | CodeableConcept | Why the component result is missing Binding: Data Absent Reason (Extensible) | ||
| 0..* | CodeableConcept | High, low, normal, etc Binding: Observation Interpretation Codes (Extensible) | ||
| 0..* | see referenceRange | Provides guide for interpretation of component result | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Definition of an observation + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: If permittedUnit exists, then permittedDataType=Quantity must exist. Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| Σ | 0..1 | uri | Logical canonical URL to reference this ObservationDefinition (globally unique) | |
| Σ | 0..1 | Identifier | Business identifier of the ObservationDefinition | |
| Σ | 0..1 | string | Business version of the ObservationDefinition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this ObservationDefinition (computer friendly) | |
| ΣT | 0..1 | string | Name for this ObservationDefinition (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | If for testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | The name of the individual or organization that published the ObservationDefinition | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the ObservationDefinition | |
| Σ | 0..* | UsageContext | Content intends to support these contexts | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for this ObservationDefinition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this ObservationDefinition is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When ObservationDefinition was approved by publisher | ||
| 0..1 | date | Date on which the asset content was last reviewed by the publisher | ||
| Σ | 0..1 | Period | The effective date range for the ObservationDefinition | |
| Σ | 0..* | canonical(ObservationDefinition) | Based on FHIR definition of another observation | |
| Σ | 0..* | uri | Based on external definition | |
| Σ | 0..* | CodeableConcept | Type of subject for the defined observation | |
| Σ | 0..1 | CodeableConcept | Desired kind of performer for such kind of observation | |
| Σ | 0..* | CodeableConcept | General type of observation Binding: Observation Category Codes (Example) | |
| Σ | 1..1 | CodeableConcept | Type of observation Binding: LOINC Codes (Example) | |
| C | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: Observation Data Type (Required) | |
| 0..1 | boolean | Multiple results allowed for conforming observations | ||
| 0..1 | CodeableConcept | Body part to be observed Binding: SNOMED CT Body Structures (Example) | ||
| 0..1 | CodeableConcept | Method used to produce the observation Binding: Observation Methods (Example) | ||
| 0..* | Reference(SpecimenDefinition) | Kind of specimen used by this type of observation | ||
| 0..* | Reference(DeviceDefinition | Device) | Measurement device or model of device | ||
| 0..1 | string | The preferred name to be used when reporting the observation results | ||
| C | 0..* | Coding | Unit for quantitative results Binding: UCUM Codes (Preferred) | |
| 0..* | BackboneElement | Set of qualified values for observation results | ||
| 0..1 | CodeableConcept | Context qualifier for the set of qualified values Binding: Observation Reference Range Meaning Codes (Extensible) | ||
| 0..* | CodeableConcept | Targetted population for the set of qualified values Binding: Observation Reference Range Applies To Codes (Example) | ||
| 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (Required) | ||
| 0..1 | Range | Applicable age range for the set of qualified values | ||
| 0..1 | Range | Applicable gestational age range for the set of qualified values | ||
| 0..1 | string | Condition associated with the set of qualified values | ||
| 0..1 | code | reference | critical | absolute Binding: Observation Range Category (Required) | ||
| 0..1 | Range | The range for continuous or ordinal observations | ||
| 0..1 | canonical(ValueSet) | Value set of valid coded values as part of this set of qualified values | ||
| 0..1 | canonical(ValueSet) | Value set of normal coded values as part of this set of qualified values | ||
| 0..1 | canonical(ValueSet) | Value set of abnormal coded values as part of this set of qualified values | ||
| 0..1 | canonical(ValueSet) | Value set of critical coded values as part of this set of qualified values | ||
| 0..* | Reference(ObservationDefinition | Questionnaire) | Definitions of related resources belonging to this kind of observation group | ||
| C | 0..* | BackboneElement | Component results + Rule: If permittedUnit exists, then permittedDataType=Quantity must exist. | |
| 1..1 | CodeableConcept | Type of observation Binding: LOINC Codes (Example) | ||
| C | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: Observation Data Type (Required) | |
| C | 0..* | Coding | Unit for quantitative results Binding: UCUM Codes (Preferred) | |
| 0..* | see qualifiedValue | Set of qualified values for observation results | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| N | DomainResource | Definition of an operation or a named query + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: A query operation cannot be defined at the instance level + Rule: A query operation requires input parameters to have a search type + Rule: Named queries always have a single output parameter named 'result' of type Bundle Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||||||
| ΣC | 0..1 | uri | Canonical identifier for this operation definition, represented as an absolute URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |||||
| ΣTU | 0..* | Identifier | Additional identifier for the implementation guide (business identifier) | |||||
| Σ | 0..1 | string | Business version of the operation definition | |||||
| ΣTU | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| ΣC | 1..1 | string | Name for this operation definition (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this operation definition (human friendly) | |||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| ΣC | 1..1 | code | operation | query Binding: Operation Kind (Required) | |||||
| Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
| Σ | 0..1 | dateTime | Date last changed | |||||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| T | 0..1 | markdown | Natural language description of the operation definition | |||||
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for operation definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| T | 0..1 | markdown | Why this operation definition is defined | |||||
| TTU | 0..1 | markdown | Use and/or publishing restrictions | |||||
| TTU | 0..1 | string | Copyright holder and year(s) | |||||
| Σ | 0..1 | boolean | Whether content is changed by the operation | |||||
| Σ | 1..1 | code | Recommended name for operation in search url | |||||
| 0..1 | markdown | Additional information about use | ||||||
| Σ | 0..1 | canonical(OperationDefinition) | Marks this as a profile of the base | |||||
| Σ | 0..* | code | Types this operation applies to Binding: Version Independent Resource Types (All) (Required)
| |||||
| Σ | 1..1 | boolean | Invoke at the system level? | |||||
| Σ | 1..1 | boolean | Invoke at the type level? | |||||
| ΣC | 1..1 | boolean | Invoke on an instance? | |||||
| 0..1 | canonical(StructureDefinition) | Validation information for in parameters | ||||||
| 0..1 | canonical(StructureDefinition) | Validation information for out parameters | ||||||
| C | 0..* | BackboneElement | Parameters for the operation/query + Rule: Either a type must be provided, or parts + Rule: A search type can only be specified for parameters of type string + Rule: A targetProfile can only be specified for parameters of type Reference, Canonical, or a Resource + Rule: SearchParamType can only be specified on in parameters | |||||
| C | 1..1 | code | Name in Parameters.parameter.name or in URL | |||||
| C | 1..1 | code | in | out Binding: Operation Parameter Use (Required) | |||||
| TU | 0..* | code | instance | type | system Binding: Operation Parameter Scope (Required) | |||||
| 1..1 | integer | Minimum Cardinality | ||||||
| 1..1 | string | Maximum Cardinality (a number or *) | ||||||
| T | 0..1 | markdown | Description of meaning/use | |||||
| C | 0..1 | code | What type this parameter has Binding: All FHIR Types (Required) | |||||
| TU | 0..* | code | Allowed sub-type this parameter can have (if type is abstract) Binding: All FHIR Types (Required) | |||||
| C | 0..* | canonical(StructureDefinition) | If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types | |||||
| C | 0..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (Required) | |||||
| 0..1 | BackboneElement | ValueSet details if this is coded | ||||||
| 1..1 | code | required | extensible | preferred | example Binding: BindingStrength (Required) | ||||||
| 1..1 | canonical(ValueSet) | Source of value set | ||||||
| TU | 0..* | BackboneElement | References to this parameter | |||||
| 1..1 | string | Referencing parameter | ||||||
| 0..1 | string | Element id of reference | ||||||
| C | 0..* | see parameter | Parts of a nested Parameter | |||||
| 0..* | BackboneElement | Define overloaded variants for when generating code | ||||||
| 0..* | string | Name of parameter to include in overload | ||||||
| 0..1 | string | Comments to go on overload | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| N | DomainResource | Information about the success/failure of an action Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 1..* | BackboneElement | A single issue associated with the action | |
| Σ | 1..1 | code | fatal | error | warning | information | success Binding: Issue Severity (Required) | |
| Σ | 1..1 | code | Error or warning code Binding: Issue Type (Required) | |
| Σ | 0..1 | CodeableConcept | Additional details about the error Binding: Operation Outcome Codes (Example) | |
| Σ | 0..1 | string | Additional diagnostic information about the issue | |
| ΣXD | 0..* | string | Deprecated: Path of element(s) related to issue | |
| Σ | 0..* | string | FHIRPath of element(s) related to issue | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A grouping of people or organizations with a common purpose + Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| ΣC | 0..* | Identifier | Identifies this organization across multiple systems | |
| ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | |
| Σ | 0..* | CodeableConcept | Kind of organization Binding: Organization Type (Example) | |
| ΣC | 0..1 | string | Name used for the organization | |
| 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||
| Σ | 0..1 | markdown | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name | |
| C | 0..* | ExtendedContactDetail | Official contact details for the Organization + Rule: The telecom of an organization can never be of use 'home' + Rule: The address of an organization can never be of use 'home' | |
| Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | |
| 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | ||
| 0..* | BackboneElement | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care | ||
| 0..* | Identifier | An identifier for this qualification for the organization | ||
| 1..1 | CodeableConcept | Coded representation of the qualification Binding: Qualification (Example) | ||
| 0..1 | Period | Period during which the qualification is valid | ||
| 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifiers that are specific to this role | |
| Σ | 0..1 | boolean | Whether this organization affiliation record is in active use | |
| Σ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | |
| Σ | 0..1 | Reference(Organization) | Organization where the role is available | |
| Σ | 0..1 | Reference(Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | |
| Σ | 0..* | Reference(Organization) | The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | |
| Σ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: Organization Affiliation Role (Example) | |
| Σ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Practice Setting Code Value Set (Preferred) | |
| Σ | 0..* | Reference(Location) | The location(s) at which the role occurs | |
| 0..* | Reference(HealthcareService) | Healthcare services provided through the role | ||
| C | 0..* | ExtendedContactDetail | Official contact details at the participatingOrganization relevant to this Affiliation + Rule: The telecom of an organization can never be of use 'home' + Rule: The address of an organization can never be of use 'home' | |
| 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for this role | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A medically related item or items, in a container or package Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | A unique identifier for this package as whole - not for the content of the package | |
| Σ | 0..1 | string | A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc | |
| Σ | 0..1 | CodeableConcept | A high level category e.g. medicinal product, raw material, shipping container etc Binding: Package Type (Example) | |
| Σ | 0..* | Reference(MedicinalProductDefinition) | The product that this is a pack for | |
| ?!Σ | 0..1 | CodeableConcept | The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status Binding: PublicationStatus (Preferred) | |
| Σ | 0..1 | dateTime | The date at which the given status became applicable | |
| Σ | 0..* | Quantity | A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. See also packaging.containedItem.amount (especially the long definition) | |
| Σ | 0..1 | markdown | Textual description. Note that this is not the name of the package or product | |
| Σ | 0..* | BackboneElement | The legal status of supply of the packaged item as classified by the regulator | |
| Σ | 0..1 | CodeableConcept | The actual status of supply. In what situation this package type may be supplied for use Binding: Legal Status Of Supply (Example) | |
| Σ | 0..1 | CodeableConcept | The place where the legal status of supply applies Binding: Jurisdiction ValueSet (Example) | |
| Σ | 0..* | MarketingStatus | Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated | |
| Σ | 0..1 | boolean | Identifies if the drug product is supplied with another item such as a diluent or adjuvant | |
| Σ | 0..* | Reference(Organization) | Manufacturer of this package type (multiple means these are all possible manufacturers) | |
| Σ | 0..* | Reference(DocumentReference) | Additional information or supporting documentation about the packaged product | |
| Σ | 0..1 | BackboneElement | A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap | |
| Σ | 0..* | Identifier | An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier | |
| Σ | 0..1 | CodeableConcept | The physical type of the container of the items Binding: Packaging Type (Example) | |
| Σ | 0..1 | boolean | Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial) | |
| Σ | 0..1 | integer | The quantity of this level of packaging in the package that contains it (with the outermost level being 1) | |
| Σ | 0..* | CodeableConcept | Material type of the package item Binding: Package Material (Example) | |
| Σ | 0..* | CodeableConcept | A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material Binding: Package Material (Example) | |
| Σ | 0..* | ProductShelfLife | Shelf Life and storage information | |
| Σ | 0..* | Reference(Organization) | Manufacturer of this packaging item (multiple means these are all potential manufacturers) | |
| Σ | 0..* | BackboneElement | General characteristics of this item | |
| Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: Product Characteristic (Example) | |
| Σ | 0..1 | A value for the characteristic | ||
| CodeableConcept | ||||
| Quantity | ||||
| date | ||||
| boolean | ||||
| Attachment | ||||
| Σ | 0..* | BackboneElement | The item(s) within the packaging | |
| Σ | 1..1 | CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct) | The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package | |
| Σ | 0..1 | Quantity | The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition) | |
| Σ | 0..* | see packaging | Allows containers (and parts of containers) within containers, still as a part of single packaged product | |
| Σ | 0..* | see property | Allows the key features to be recorded, such as "hospital pack", "nurse prescribable" | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| N | Resource | Operation Request or Response Elements defined in Ancestors: id, meta, implicitRules, language | ||
| ΣC | 0..* | BackboneElement | Operation Parameter + Rule: A parameter must have one and only one of (value, resource, part) | |
| Σ | 1..1 | string | Name from the definition | |
| ΣC | 0..1 | * | If parameter is a data type | |
| ΣC | 0..1 | Resource | If parameter is a whole resource | |
| ΣC | 0..* | see parameter | Named part of a multi-part parameter | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| N | DomainResource | Information about an individual or animal receiving health care services Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | An identifier for this patient | |||||
| ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | |||||
| Σ | 0..* | HumanName | A name associated with the patient | |||||
| Σ | 0..* | ContactPoint | A contact detail for the individual | |||||
| Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (Required) | |||||
| Σ | 0..1 | date | The date of birth for the individual | |||||
| ?!Σ | 0..1 | Indicates if the individual is deceased or not | ||||||
| boolean | ||||||||
| dateTime | ||||||||
| Σ | 0..* | Address | An address for the individual | |||||
| 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (Extensible) | ||||||
| 0..1 | Whether patient is part of a multiple birth | |||||||
| boolean | ||||||||
| integer | ||||||||
| 0..* | Attachment | Image of the patient | ||||||
| C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient + Rule: SHALL at least contain a contact's details or a reference to an organization | |||||
| 0..* | CodeableConcept | The kind of relationship Binding: Patient Contact Relationship (Extensible) | ||||||
| C | 0..1 | HumanName | A name associated with the contact person | |||||
| C | 0..* | ContactPoint | A contact detail for the person | |||||
| C | 0..1 | Address | Address for the contact person | |||||
| 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (Required) | ||||||
| C | 0..1 | Reference(Organization) | Organization that is associated with the contact | |||||
| 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||||
| 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||||
| 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: All Languages (Required)
| ||||||
| 0..1 | boolean | Language preference indicator | ||||||
| 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | ||||||
| Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |||||
| ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual | |||||
| Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |||||
| Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: Link Type (Required) | |||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | PaymentNotice request Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier for the payment notice | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| 0..1 | Reference(Any) | Request reference | ||
| 0..1 | Reference(Any) | Response reference | ||
| Σ | 1..1 | dateTime | Creation date | |
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | ||
| Σ | 0..1 | Reference(PaymentReconciliation) | Payment reference | |
| 0..1 | date | Payment or clearing date | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party being paid | ||
| Σ | 1..1 | Reference(Organization) | Party being notified | |
| Σ | 1..1 | Money | Monetary amount of the payment | |
| 0..1 | CodeableConcept | Issued or cleared Status of the payment Binding: Payment Status Codes (Example) | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | PaymentReconciliation resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier for a payment reconciliation | ||
| Σ | 1..1 | CodeableConcept | Category of payment Binding: Payment Type Codes (Extensible) | |
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| 0..1 | CodeableConcept | Workflow originating payment Binding: Payment Kind (Extensible) | ||
| Σ | 0..1 | Period | Period covered | |
| Σ | 1..1 | dateTime | Creation date | |
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who entered the payment | ||
| 0..1 | CodeableConcept | Nature of the source Binding: Payment Issuer Type (Extensible) | ||
| Σ | 0..1 | Reference(Organization | Patient | RelatedPerson) | Party generating payment | |
| 0..1 | Reference(Task) | Reference to requesting resource | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | ||
| 0..1 | code | queued | complete | error | partial Binding: Payment Outcome (Required) | ||
| 0..1 | string | Disposition message | ||
| Σ | 1..1 | date | When payment issued | |
| 0..1 | Reference(Location) | Where payment collected | ||
| 0..1 | CodeableConcept | Payment instrument Binding: hl7VS-paymentMethodCode (Extensible) | ||
| 0..1 | string | Type of card | ||
| 0..1 | string | Digits for verification | ||
| 0..1 | date | Expiration year-month | ||
| 0..1 | string | Processor name | ||
| 0..1 | string | Check number or payment reference | ||
| 0..1 | string | Authorization number | ||
| 0..1 | Money | Amount offered by the issuer | ||
| 0..1 | Money | Amount returned by the receiver | ||
| Σ | 1..1 | Money | Total amount of Payment | |
| 0..1 | Identifier | Business identifier for the payment | ||
| 0..* | BackboneElement | Settlement particulars | ||
| 0..1 | Identifier | Business identifier of the payment detail | ||
| 0..1 | Identifier | Business identifier of the prior payment detail | ||
| 0..1 | Reference(Claim | Account | Invoice | ChargeItem | Encounter | Contract) | Subject of the payment | ||
| 0..1 | Sub-element of the subject | |||
| string | ||||
| Identifier | ||||
| positiveInt | ||||
| 0..1 | Reference(Encounter) | Applied-to encounter | ||
| 0..1 | Reference(Account) | Applied-to account | ||
| 0..1 | CodeableConcept | Category of payment Binding: Payment Type Codes (Extensible) | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Submitter of the request | ||
| 0..1 | Reference(ClaimResponse) | Response committing to a payment | ||
| 0..1 | date | Date of commitment to pay | ||
| 0..1 | Reference(PractitionerRole) | Contact for the response | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Recipient of the payment | ||
| 0..1 | Money | Amount allocated to this payable | ||
| 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (Example) | ||
| 0..* | BackboneElement | Note concerning processing | ||
| 0..1 | code | display | print | printoper Binding: NoteType (Required) | ||
| 0..1 | string | Note explanatory text | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Access Rules Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 1..1 | code | active | entered-in-error | draft | rejected Binding: Permission Status (Required) | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) | The person or entity that asserts the permission | |
| Σ | 0..* | dateTime | The date that permission was asserted | |
| Σ | 0..1 | Period | The period in which the permission is active | |
| Σ | 0..1 | BackboneElement | The asserted justification for using the data | |
| Σ | 0..* | CodeableConcept | The regulatory grounds upon which this Permission builds Binding: Consent PolicyRule Codes (Example) | |
| Σ | 0..* | Reference(Any) | Justifing rational | |
| ?!Σ | 1..1 | code | deny-overrides | permit-overrides | ordered-deny-overrides | ordered-permit-overrides | deny-unless-permit | permit-unless-deny Binding: Permission Rule Combining (Required) | |
| Σ | 0..* | BackboneElement | Constraints to the Permission This repeating element order: The order of the rules processing is defined in rule-combining | |
| ?!Σ | 0..1 | code | deny | permit Binding: Consent Provision Type (Required) | |
| Σ | 0..* | BackboneElement | The selection criteria to identify data that is within scope of this provision | |
| Σ | 0..* | BackboneElement | Explicit FHIR Resource references | |
| Σ | 1..1 | code | instance | related | dependents | authoredby Binding: Consent Data Meaning (Required) | |
| Σ | 1..1 | Reference(Any) | The actual data reference | |
| Σ | 0..* | Coding | Security tag code on .meta.security | |
| Σ | 0..* | Period | Timeframe encompasing data create/update | |
| Σ | 0..1 | Expression | Expression identifying the data | |
| Σ | 0..* | BackboneElement | A description or definition of which activities are allowed to be done on the data | |
| Σ | 0..* | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Authorized actor(s) | |
| Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: Consent Action Codes (Example) | |
| Σ | 0..* | CodeableConcept | The purpose for which the permission is given Binding: PurposeOfUse (Preferred) | |
| Σ | 0..* | CodeableConcept | What limits apply to the use of the data Binding: Example set of Event / Bundle used Security Labels (Example) | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | A generic person record Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | A human identifier for this person | |||||
| ?!Σ | 0..1 | boolean | This person's record is in active use | |||||
| Σ | 0..* | HumanName | A name associated with the person | |||||
| Σ | 0..* | ContactPoint | A contact detail for the person | |||||
| Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (Required) | |||||
| Σ | 0..1 | date | The date on which the person was born | |||||
| Σ | 0..1 | Indicates if the individual is deceased or not | ||||||
| boolean | ||||||||
| dateTime | ||||||||
| Σ | 0..* | Address | One or more addresses for the person | |||||
| 0..1 | CodeableConcept | Marital (civil) status of a person Binding: Marital Status Codes (Extensible) | ||||||
| 0..* | Attachment | Image of the person | ||||||
| 0..* | BackboneElement | A language which may be used to communicate with the person about his or her health | ||||||
| 1..1 | CodeableConcept | The language which can be used to communicate with the person about his or her health Binding: All Languages (Required)
| ||||||
| 0..1 | boolean | Language preference indicator | ||||||
| Σ | 0..1 | Reference(Organization) | The organization that is the custodian of the person record | |||||
| 0..* | BackboneElement | Link to a resource that concerns the same actual person | ||||||
| 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | The resource to which this actual person is associated | ||||||
| 0..1 | code | level1 | level2 | level3 | level4 Binding: Identity Assurance Level (Required) | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | The definition of a plan for a series of actions, independent of any specific patient or context + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Warning: goalid should reference the id of a goal definition + Warning: targetId should reference the id of an action Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the plan definition | |
| Σ | 0..1 | string | Business version of the plan definition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this plan definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this plan definition (human friendly) | |
| T | 0..1 | string | Subordinate title of the plan definition | |
| Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: Plan Definition Type (Extensible) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| 0..1 | Type of individual the plan definition is focused on Binding: Participant Resource Types (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | ||||
| canonical(EvidenceVariable) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the plan definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this plan definition is defined | |
| T | 0..1 | markdown | Describes the clinical usage of the plan | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the plan definition was approved by publisher | ||
| 0..1 | date | When the plan definition was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the plan definition is expected to be used | |
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: Definition Topic (Example) | |
| 0..* | ContactDetail | Who authored the content | ||
| 0..* | ContactDetail | Who edited the content | ||
| 0..* | ContactDetail | Who reviewed the content | ||
| 0..* | ContactDetail | Who endorsed the content | ||
| 0..* | RelatedArtifact | Additional documentation, citations | ||
| 0..* | canonical(Library) | Logic used by the plan definition | ||
| C | 0..* | BackboneElement | What the plan is trying to accomplish | |
| 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: Goal Category (Example) | ||
| 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMED CT Clinical Findings (Example) | ||
| 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: Goal Priority (Preferred) | ||
| 0..1 | CodeableConcept | When goal pursuit begins Binding: Goal Start Event (Example) | ||
| 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/Diagnosis Codes (Example) | ||
| 0..* | RelatedArtifact | Supporting documentation for the goal | ||
| 0..* | BackboneElement | Target outcome for the goal | ||
| 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINC Codes (Example) | ||
| 0..1 | The target value to be achieved | |||
| Quantity | ||||
| Range | ||||
| CodeableConcept | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| Ratio | ||||
| 0..1 | Duration | Reach goal within | ||
| 0..* | BackboneElement | Actors within the plan | ||
| T | 0..1 | string | User-visible title | |
| T | 0..1 | markdown | Describes the actor | |
| 1..* | BackboneElement | Who or what can be this actor | ||
| 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: Action Participant Type (Required) | ||
| 0..1 | canonical(CapabilityStatement) | Who or what can participate | ||
| 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | ||
| 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (Example) | ||
| C | 0..* | BackboneElement | Action defined by the plan | |
| 0..1 | string | Unique id for the action in the PlanDefinition | ||
| 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | ||
| T | 0..1 | string | User-visible title | |
| T | 0..1 | markdown | Brief description of the action | |
| T | 0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |
| 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | ||
| 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Action Code (Example) | ||
| 0..* | CodeableConcept | Why the action should be performed Binding: Action Reason Code (Example) | ||
| 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | ||
| C | 0..* | id | What goals this action supports | |
| 0..1 | Type of individual the action is focused on Binding: Participant Resource Types (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| canonical() | ||||
| 0..* | TriggerDefinition | When the action should be triggered | ||
| 0..* | BackboneElement | Whether or not the action is applicable | ||
| 1..1 | code | applicability | start | stop Binding: Action Condition Kind (Required) | ||
| 0..1 | Expression | Boolean-valued expression | ||
| C | 0..* | BackboneElement | Input data requirements + Rule: Input data elements must have a requirement or a relatedData, but not both | |
| T | 0..1 | string | User-visible title | |
| C | 0..1 | DataRequirement | What data is provided | |
| C | 0..1 | id | What data is provided | |
| C | 0..* | BackboneElement | Output data definition + Rule: Output data element must have a requirement or a relatedData, but not both | |
| T | 0..1 | string | User-visible title | |
| C | 0..1 | DataRequirement | What data is provided | |
| C | 0..1 | string | What data is provided | |
| C | 0..* | BackboneElement | Relationship to another action | |
| C | 1..1 | id | What action is this related to | |
| 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: Action Relationship Type (Required) | ||
| 0..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: Action Relationship Type (Required) | ||
| 0..1 | Time offset for the relationship | |||
| Duration | ||||
| Range | ||||
| 0..1 | When the action should take place | |||
| Age | ||||
| Duration | ||||
| Range | ||||
| Timing | ||||
| 0..1 | CodeableReference(Location) | Where it should happen | ||
| 0..* | BackboneElement | Who should participate in the action | ||
| 0..1 | string | What actor | ||
| 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: Action Participant Type (Required) | ||
| 0..1 | canonical(CapabilityStatement) | Who or what can participate | ||
| 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | ||
| 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (Example) | ||
| 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: Action Participant Function (Example) | ||
| 0..1 | CodeableConcept | create | update | remove | fire-event Binding: Action Type (Extensible) | ||
| 0..1 | code | visual-group | logical-group | sentence-group Binding: Action Grouping Behavior (Required) | ||
| 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: Action Selection Behavior (Required) | ||
| 0..1 | code | must | could | must-unless-documented Binding: Action Required Behavior (Required) | ||
| 0..1 | code | yes | no Binding: Action Precheck Behavior (Required) | ||
| 0..1 | code | single | multiple Binding: Action Cardinality Behavior (Required) | ||
| 0..1 | Description of the activity to be performed | |||
| canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | ||||
| uri | ||||
| 0..1 | canonical(StructureMap) | Transform to apply the template | ||
| 0..* | BackboneElement | Dynamic aspects of the definition | ||
| 0..1 | string | The path to the element to be set dynamically | ||
| 0..1 | Expression | An expression that provides the dynamic value for the customization | ||
| 0..* | see action | A sub-action | ||
| Σ | 0..1 | Preconditions for service Binding: SNOMED CT Medication As Needed Reason Codes (Example) | ||
| boolean | ||||
| CodeableConcept | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | A person with a formal responsibility in the provisioning of healthcare or related services Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | An identifier for the person as this agent | |||||
| ?!Σ | 0..1 | boolean | Whether this practitioner's record is in active use | |||||
| Σ | 0..* | HumanName | The name(s) associated with the practitioner | |||||
| Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | |||||
| Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (Required) | |||||
| Σ | 0..1 | date | The date on which the practitioner was born | |||||
| Σ | 0..1 | Indicates if the practitioner is deceased or not | ||||||
| boolean | ||||||||
| dateTime | ||||||||
| Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | |||||
| 0..* | Attachment | Image of the person | ||||||
| 0..* | BackboneElement | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care | ||||||
| 0..* | Identifier | An identifier for this qualification for the practitioner | ||||||
| 1..1 | CodeableConcept | Coded representation of the qualification Binding: hl7VS-degreeLicenseCertificate (Example) | ||||||
| 0..1 | Period | Period during which the qualification is valid | ||||||
| 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||||||
| 0..* | BackboneElement | A language which may be used to communicate with the practitioner | ||||||
| 1..1 | CodeableConcept | The language code used to communicate with the practitioner Binding: All Languages (Required)
| ||||||
| 0..1 | boolean | Language preference indicator | ||||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | Roles/organizations the practitioner is associated with Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | Identifiers for a role/location | |||||
| Σ | 0..1 | boolean | Whether this practitioner role record is in active use | |||||
| Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||
| Σ | 0..1 | Reference(Practitioner) | Practitioner that provides services for the organization | |||||
| Σ | 0..1 | Reference(Organization) | Organization where the roles are available | |||||
| Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (Example) | |||||
| Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Practice Setting Code Value Set (Preferred) | |||||
| Σ | 0..* | Reference(Location) | Location(s) where the practitioner provides care | |||||
| 0..* | Reference(HealthcareService) | Healthcare services provided for this role's Organization/Location(s) | ||||||
| 0..* | ExtendedContactDetail | Official contact details relating to this PractitionerRole | ||||||
| 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: Service Mode (Example) | ||||||
| 0..* | CodeableConcept | A language the practitioner (in this role) can use in patient communication Binding: All Languages (Required)
| ||||||
| 0..* | Availability | Times the Practitioner is available at this location and/or healthcare service (including exceptions) | ||||||
| 0..* | Reference(Endpoint) | Endpoints for interacting with the practitioner in this role | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An action that is being or was performed on an individual or entity Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Identifiers for this procedure | |
| Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | |
| Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | |
| ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (Required) | |
| Σ | 0..1 | CodeableConcept | Reason for current status Binding: Procedure Not Performed Reason (SNOMED-CT) (Example) | |
| Σ | 0..* | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (Example) | |
| Σ | 0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Codes (SNOMED CT) (Example) | |
| Σ | 1..1 | Reference(Patient | Group | Device | Practitioner | Organization | Location) | Individual or entity the procedure was performed on | |
| Σ | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | Organization | CareTeam | PractitionerRole | Specimen) | Who is the target of the procedure when it is not the subject of record only | |
| Σ | 0..1 | Reference(Encounter) | The Encounter during which this Procedure was created | |
| Σ | 0..1 | When the procedure occurred or is occurring | ||
| dateTime | ||||
| Period | ||||
| string | ||||
| Age | ||||
| Range | ||||
| Timing | ||||
| Σ | 0..1 | dateTime | When the procedure was first captured in the subject's record | |
| Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | |
| Σ | 0..1 | Reported rather than primary record | ||
| boolean | ||||
| Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | ||||
| ΣC | 0..* | BackboneElement | Who performed the procedure and what they did + Rule: Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole | |
| Σ | 0..1 | CodeableConcept | Type of performance Binding: Procedure Performer Role Codes (Example) | |
| ΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam | HealthcareService) | Who performed the procedure | |
| C | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |
| 0..1 | Period | When the performer performed the procedure | ||
| Σ | 0..1 | Reference(Location) | Where the procedure happened | |
| Σ | 0..* | CodeableReference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Binding: Procedure Reason Codes (Example) | |
| Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (Example) | |
| Σ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (Example) | |
| 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | ||
| 0..* | CodeableReference(Condition) | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (Example) | ||
| 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (Example) | ||
| 0..* | Annotation | Additional information about the procedure | ||
| 0..* | BackboneElement | Manipulated, implanted, or removed device | ||
| 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (Preferred) | ||
| 1..1 | Reference(Device) | Device that was changed | ||
| 0..* | CodeableReference(Device | Medication | Substance | BiologicallyDerivedProduct) | Items used during procedure Binding: Device Type (Example) | ||
| 0..* | Reference(Any) | Extra information relevant to the procedure | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Who, What, When for a set of resources Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 1..* | Reference(Any) | Target Reference(s) (usually version specific) | |
| 0..1 | When the activity occurred | |||
| Period | ||||
| dateTime | ||||
| Σ | 0..1 | instant | When the activity was recorded / updated | |
| 0..* | uri | Policy or plan the activity was defined by | ||
| 0..1 | Reference(Location) | Where the activity occurred, if relevant | ||
| 0..* | CodeableReference() | Authorization (purposeOfUse) related to the event Binding: PurposeOfUse (Example) | ||
| 0..1 | CodeableConcept | Activity that occurred Binding: ValueSet of sample of representative activity type codes. (Example) | ||
| TU | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | |
| TU | 0..1 | Reference(Patient) | The patient is the subject of the data created/updated (.target) by the activity | |
| TU | 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |
| ΣC | 1..* | BackboneElement | Actor involved + Rule: Who and onBehalfOf cannot be the same + Rule: If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner + Rule: If who is an organization, onBehalfOf can't be a PractitionerRole within that organization | |
| Σ | 0..1 | CodeableConcept | How the agent participated Binding: Participation Role Type (Example) | |
| 0..* | CodeableConcept | What the agents role was Binding: Security Role Type (Example) | ||
| ΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event | |
| C | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated | |
| ΣTU | 0..* | BackboneElement | An entity used in this activity | |
| Σ | 1..1 | code | revision | quotation | source | instantiates | removal Binding: Provenance Entity Role (Required) | |
| Σ | 1..1 | Reference(Any) | Identity of entity | |
| 0..* | see agent | Entity is attributed to this agent | ||
| TU | 0..* | Signature | Signature on target | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A structured set of questions + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: The link ids for groups and questions must be unique within the questionnaire Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as an absolute URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Business identifier for questionnaire | |
| Σ | 0..1 | string | Business version of the questionnaire | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | |
| ΣT | 0..1 | string | Name for this questionnaire (human friendly) | |
| Σ | 0..* | canonical(Questionnaire) | Based on Questionnaire | |
| ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: Resource Types (Required) | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| ΣT | 0..1 | markdown | Natural language description of the questionnaire | |
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this questionnaire is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When the questionnaire was approved by publisher | ||
| 0..1 | date | When the questionnaire was last reviewed by the publisher | ||
| Σ | 0..1 | Period | When the questionnaire is expected to be used | |
| Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (Example) | |
| C | 0..* | BackboneElement | Questions and sections within the Questionnaire + Rule: Group items must have nested items when Questionanire is complete + Warning: Groups should have items + Rule: Display items cannot have child items + Rule: Display items cannot have a "code" asserted + Rule: A question cannot have both answerOption and answerValueSet + Rule: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet + Rule: Required and repeat aren't permitted for display items + Rule: Initial values can't be specified for groups or display items + Rule: Read-only can't be specified for "display" items + Rule: Maximum length can only be declared for simple question types + Rule: If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead + Rule: If there are more than one enableWhen, enableBehavior must be specified + Rule: Can only have multiple initial values for repeating items + Warning: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) | |
| C | 1..1 | string | Unique id for item in questionnaire + Warning: Link ids should be 255 characters or less | |
| 0..1 | uri | ElementDefinition - details for the item | ||
| C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: Questionnaire Question Codes (Example) | |
| 0..1 | string | E.g. "1(a)", "2.5.3" | ||
| T | 0..1 | string | Primary text for the item | |
| C | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: Questionnaire Item Type (Required) | |
| ?!C | 0..* | BackboneElement | Only allow data when + Rule: If the operator is 'exists', the value must be a boolean | |
| 1..1 | string | The linkId of question that determines whether item is enabled/disabled | ||
| C | 1..1 | code | exists | = | != | > | < | >= | <= Binding: Questionnaire Item Operator (Required) | |
| TC | 1..1 | Value for question comparison based on operator Binding: Questionnaire Answer Codes (Example) | ||
| boolean | ||||
| decimal | ||||
| integer | ||||
| date | ||||
| dateTime | ||||
| time | ||||
| string | ||||
| Coding | ||||
| Quantity | ||||
| Reference(Any) | ||||
| C | 0..1 | code | all | any Binding: Enable When Behavior (Required) | |
| 0..1 | code | hidden | protected Binding: Questionnaire Item Disabled Display (Required) | ||
| C | 0..1 | boolean | Whether the item must be included in data results | |
| C | 0..1 | boolean | Whether the item may repeat | |
| C | 0..1 | boolean | Don't allow human editing | |
| C | 0..1 | integer | No more than these many characters | |
| C | 0..1 | code | optionsOnly | optionsOrType | optionsOrString Binding: Questionnaire answer constraints value set (Required) | |
| C | 0..1 | canonical(ValueSet) | ValueSet containing permitted answers | |
| C | 0..* | BackboneElement | Permitted answer | |
| T | 1..1 | Answer value Binding: Questionnaire Answer Codes (Example) | ||
| integer | ||||
| date | ||||
| time | ||||
| string | ||||
| Coding | ||||
| Reference(Any) | ||||
| 0..1 | boolean | Whether option is selected by default | ||
| C | 0..* | BackboneElement | Initial value(s) when item is first rendered | |
| T | 1..1 | Actual value for initializing the question Binding: Questionnaire Answer Codes (Example) | ||
| boolean | ||||
| decimal | ||||
| integer | ||||
| date | ||||
| dateTime | ||||
| time | ||||
| string | ||||
| uri | ||||
| Attachment | ||||
| Coding | ||||
| Quantity | ||||
| Reference(Any) | ||||
| 0..* | see item | Nested questionnaire items | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A structured set of questions and their answers Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for this set of answers | |
| Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | |
| Σ | 0..* | Reference(Observation | Procedure) | Part of referenced event | |
| Σ | 1..1 | canonical(Questionnaire) | Canonical URL of Questionnaire being answered | |
| ?!Σ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: Questionnaire Response Status (Required) | |
| Σ | 0..1 | Reference(Any) | The subject of the questions | |
| Σ | 0..1 | Reference(Encounter) | Encounter the questionnaire response is part of | |
| Σ | 0..1 | dateTime | Date the answers were gathered | |
| Σ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | The individual or device that received and recorded the answers | |
| Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | The individual or device that answered the questions | |
| C | 0..* | BackboneElement | Groups and questions + Rule: Item cannot contain both item and answer + Rule: Repeated answers are combined in the answers array of a single item | |
| C | 1..1 | string | Pointer to specific item from Questionnaire | |
| 0..1 | uri | ElementDefinition - details for the item | ||
| 0..1 | string | Name for group or question text | ||
| C | 0..* | BackboneElement | The response(s) to the question | |
| C | 1..1 | Single-valued answer to the question Binding: Questionnaire Answer Codes (Example) | ||
| boolean | ||||
| decimal | ||||
| integer | ||||
| date | ||||
| dateTime | ||||
| time | ||||
| string | ||||
| uri | ||||
| Attachment | ||||
| Coding | ||||
| SimpleQuantity | ||||
| Reference(Any) | ||||
| 0..* | see item | Child items of question | ||
| 0..* | see item | Child items of group item | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier for the authorization, typically assigned by the authorizing body | |
| Σ | 0..* | Reference(MedicinalProductDefinition | BiologicallyDerivedProduct | NutritionProduct | PackagedProductDefinition | ManufacturedItemDefinition | Ingredient | SubstanceDefinition | DeviceDefinition | ResearchStudy | ActivityDefinition | PlanDefinition | ObservationDefinition | Practitioner | Organization | Location) | The product type, treatment, facility or activity that is being authorized | |
| Σ | 0..1 | CodeableConcept | Overall type of this authorization, for example drug marketing approval, orphan drug designation Binding: Regulated Authorization Type (Example) | |
| Σ | 0..1 | markdown | General textual supporting information | |
| Σ | 0..* | CodeableConcept | The territory in which the authorization has been granted Binding: Jurisdiction ValueSet (Example) | |
| Σ | 0..1 | CodeableConcept | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications Binding: PublicationStatus (Preferred) | |
| Σ | 0..1 | dateTime | The date at which the current status was assigned | |
| Σ | 0..1 | Period | The time period in which the regulatory approval etc. is in effect, e.g. a Marketing Authorization includes the date of authorization and/or expiration date | |
| Σ | 0..* | CodeableReference(ClinicalUseDefinition) | Condition for which the use of the regulated product applies | |
| Σ | 0..1 | CodeableConcept | The intended use of the product, e.g. prevention, treatment Binding: Product Intended Use (Preferred) | |
| Σ | 0..* | CodeableConcept | The legal/regulatory framework or reasons under which this authorization is granted Binding: Regulated Authorization Basis (Example) | |
| Σ | 0..1 | Reference(Organization) | The organization that has been granted this authorization, by the regulator | |
| Σ | 0..1 | Reference(Organization) | The regulatory authority or authorizing body granting the authorization | |
| Σ | 0..* | Reference(DocumentReference) | Additional information or supporting documentation about the authorization | |
| Σ | 0..1 | BackboneElement | The case or regulatory procedure for granting or amending a regulated authorization. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page) | |
| Σ | 0..1 | Identifier | Identifier by which this case can be referenced | |
| Σ | 0..1 | CodeableConcept | The defining type of case Binding: Regulated Authorization Case Type (Example) | |
| Σ | 0..1 | CodeableConcept | The status associated with the case Binding: PublicationStatus (Preferred) | |
| Σ | 0..1 | Relevant date for this case | ||
| Period | ||||
| dateTime | ||||
| Σ | 0..* | see case | Applications submitted to obtain a regulated authorization. Steps within the longer running case or procedure | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | A person that is related to a patient, but who is not a direct target of care Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | A human identifier for this person | |||||
| ?!Σ | 0..1 | boolean | Whether this related person's record is in active use | |||||
| Σ | 1..1 | Reference(Patient) | The patient this person is related to | |||||
| Σ | 0..* | CodeableConcept | The relationship of the related person to the patient Binding: Patient Relationship Type (Preferred) | |||||
| Σ | 0..* | HumanName | A name associated with the person | |||||
| Σ | 0..* | ContactPoint | A contact detail for the person | |||||
| Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (Required) | |||||
| Σ | 0..1 | date | The date on which the related person was born | |||||
| Σ | 0..* | Address | Address where the related person can be contacted or visited | |||||
| 0..* | Attachment | Image of the person | ||||||
| 0..1 | Period | Period of time that this relationship is considered valid | ||||||
| 0..* | BackboneElement | A language which may be used to communicate with the related person about the patient's health | ||||||
| 1..1 | CodeableConcept | The language which can be used to communicate with the related person about the patient's health Binding: All Languages (Required)
| ||||||
| 0..1 | boolean | Language preference indicator | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A set of related requests Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business identifier | |
| Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| 0..* | Reference(Any) | Fulfills plan, proposal, or order | ||
| 0..* | Reference(Any) | Request(s) replaced by this request | ||
| Σ | 0..1 | Identifier | Composite request this is part of | |
| ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (Required) | |
| ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (Required) | |
| Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | |
| Σ | 0..1 | CodeableConcept | What's being requested/ordered Binding: Action Code (Example) | |
| 0..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who the request orchestration is about | ||
| 0..1 | Reference(Encounter) | Created as part of | ||
| 0..1 | dateTime | When the request orchestration was authored | ||
| 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request orchestration | ||
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request orchestration is needed Binding: Action Reason Code (Example) | ||
| 0..* | Reference(Goal) | What goals | ||
| 0..* | Annotation | Additional notes about the response | ||
| C | 0..* | BackboneElement | Proposed actions, if any + Rule: Must have resource or action but not both | |
| 0..1 | string | Pointer to specific item from the PlanDefinition | ||
| 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | ||
| 0..1 | string | User-visible title | ||
| Σ | 0..1 | markdown | Short description of the action | |
| Σ | 0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |
| 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | ||
| 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: Action Code (Example) | ||
| 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | ||
| 0..* | Reference(Goal) | What goals | ||
| 0..* | BackboneElement | Whether or not the action is applicable | ||
| 1..1 | code | applicability | start | stop Binding: Action Condition Kind (Required) | ||
| 0..1 | Expression | Boolean-valued expression | ||
| C | 0..* | BackboneElement | Input data requirements + Rule: Input data elements must have a requirement or a relatedData, but not both | |
| 0..1 | string | User-visible title | ||
| C | 0..1 | DataRequirement | What data is provided | |
| C | 0..1 | id | What data is provided | |
| C | 0..* | BackboneElement | Output data definition + Rule: Output data element must have a requirement or a relatedData, but not both | |
| 0..1 | string | User-visible title | ||
| C | 0..1 | DataRequirement | What data is provided | |
| C | 0..1 | string | What data is provided | |
| 0..* | BackboneElement | Relationship to another action | ||
| 1..1 | id | What action this is related to | ||
| 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: Action Relationship Type (Required) | ||
| 0..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: Action Relationship Type (Required) | ||
| 0..1 | Time offset for the relationship | |||
| Duration | ||||
| Range | ||||
| 0..1 | When the action should take place | |||
| dateTime | ||||
| Age | ||||
| Period | ||||
| Duration | ||||
| Range | ||||
| Timing | ||||
| 0..1 | CodeableReference(Location) | Where it should happen | ||
| 0..* | BackboneElement | Who should perform the action | ||
| 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: Action Participant Type (Required) | ||
| 0..1 | canonical(CapabilityStatement) | Who or what can participate | ||
| 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | ||
| 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: Action Participant Role (Example) | ||
| 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: Action Participant Function (Example) | ||
| 0..1 | Who/what is participating? | |||
| canonical(CapabilityStatement) | ||||
| Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||
| 0..1 | CodeableConcept | create | update | remove | fire-event Binding: Action Type (Extensible) | ||
| 0..1 | code | visual-group | logical-group | sentence-group Binding: Action Grouping Behavior (Required) | ||
| 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: Action Selection Behavior (Required) | ||
| 0..1 | code | must | could | must-unless-documented Binding: Action Required Behavior (Required) | ||
| 0..1 | code | yes | no Binding: Action Precheck Behavior (Required) | ||
| 0..1 | code | single | multiple Binding: Action Cardinality Behavior (Required) | ||
| C | 0..1 | Reference(Any) | The target of the action | |
| 0..1 | Description of the activity to be performed | |||
| canonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | ||||
| uri | ||||
| 0..1 | canonical(StructureMap) | Transform to apply the template | ||
| 0..* | BackboneElement | Dynamic aspects of the definition | ||
| 0..1 | string | The path to the element to be set dynamically | ||
| 0..1 | Expression | An expression that provides the dynamic value for the customization | ||
| 0..* | see action | Sub action | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A set of requirements - features of systems that are necessary + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this Requirements, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the Requirements (business identifier) | |
| Σ | 0..1 | string | Business version of the Requirements | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this Requirements (computer friendly) | |
| ΣT | 0..1 | string | Name for this Requirements (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the requirements | |
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for Requirements (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this Requirements is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| Σ | 0..* | canonical(Requirements) | Other set of Requirements this builds on | |
| 0..* | url | External artifact (rule/document etc. that) created this set of requirements | ||
| 0..* | canonical(ActorDefinition) | Actor for these requirements | ||
| 0..* | BackboneElement | Actual statement as markdown | ||
| 1..1 | id | Key that identifies this statement | ||
| T | 0..1 | string | Short Human label for this statement | |
| 0..* | code | SHALL | SHOULD | MAY | SHOULD-NOT Binding: Conformance Expectation (Required) | ||
| 0..1 | boolean | Set to true if requirements statement is conditional | ||
| T | 1..1 | markdown | The actual requirement | |
| 0..1 | string | Another statement this clarifies/restricts ([url#]key) | ||
| 0..1 | string | A larger requirement that this requirement helps to refine and enable | ||
| 0..* | url | Design artifact that satisfies this requirement | ||
| 0..* | url | External artifact (rule/document etc. that) created this requirement | ||
| 0..* | Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who asked for this statement | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Investigation to increase healthcare-related patient-independent knowledge Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..1 | uri | Canonical identifier for this study resource | ||
| Σ | 0..* | Identifier | Business Identifier for study | |
| 0..1 | string | The business version for the study record | ||
| 0..1 | string | Name for this study (computer friendly) | ||
| Σ | 0..1 | string | Human readable name of the study | |
| 0..* | BackboneElement | Additional names for the study | ||
| 0..1 | CodeableConcept | primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid Binding: Title Type (Extensible) | ||
| 0..1 | string | The name | ||
| Σ | 0..* | Reference(PlanDefinition) | Steps followed in executing study | |
| Σ | 0..* | Reference(ResearchStudy) | Part of larger study | |
| 0..* | RelatedArtifact | References, URLs, and attachments | ||
| 0..1 | dateTime | Date the resource last changed | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility Binding: Research Study Primary Purpose Type (Preferred) | |
| Σ | 0..1 | CodeableConcept | n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 Binding: Research Study Phase (Example) | |
| Σ | 0..* | CodeableConcept | Classifications of the study design characteristics Binding: Study Design (Preferred) | |
| 0..* | CodeableReference(Medication | MedicinalProductDefinition | SubstanceDefinition | EvidenceVariable) | Drugs, devices, etc. under study Binding: Research Study Focus Type (Example) | ||
| Σ | 0..* | CodeableConcept | Condition being studied Binding: Condition/Problem/Diagnosis Codes (Example) | |
| Σ | 0..* | CodeableConcept | Used to search for the study Binding: ResearchStudyKeyword (Example) | |
| Σ | 0..* | CodeableConcept | Geographic area for the study Binding: Jurisdiction ValueSet (Extensible) | |
| 0..1 | markdown | Brief text explaining the study | ||
| 0..1 | markdown | Detailed narrative of the study | ||
| Σ | 0..1 | Period | When the study began and ended | |
| Σ | 0..* | Reference(Location | ResearchStudy | Organization) | Facility where study activities are conducted | |
| 0..* | Annotation | Comments made about the study | ||
| 0..* | CodeableConcept | Classification for the study Binding: Research Study Classifiers (Example) | ||
| 0..* | BackboneElement | Sponsors, collaborators, and other parties | ||
| 0..1 | string | Name of associated party | ||
| 1..1 | CodeableConcept | sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair Binding: Research Study Party Role (Extensible) | ||
| 0..* | Period | When active in the role | ||
| 0..* | CodeableConcept | nih | fda | government | nonprofit | academic | industry Binding: Research Study Party Organization Type (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization associated with study (use practitionerRole to specify their organisation) | ||
| 0..* | BackboneElement | Status of study with time for that status | ||
| 1..1 | CodeableConcept | Label for status or state (e.g. recruitment status) Binding: Research Study Status (Extensible) | ||
| 0..1 | boolean | Actual if true else anticipated | ||
| 0..1 | Period | Date range | ||
| Σ | 0..1 | CodeableConcept | accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design Binding: Research Study Reason Stopped (Example) | |
| Σ | 0..1 | BackboneElement | Target or actual group of participants enrolled in study | |
| 0..1 | unsignedInt | Estimated total number of participants to be enrolled | ||
| 0..1 | unsignedInt | Actual total number of participants enrolled in study | ||
| 0..1 | Reference(Group | EvidenceVariable) | Inclusion and exclusion criteria | ||
| Σ | 0..1 | Reference(Group) | Group of participants who were enrolled in study | |
| 0..* | BackboneElement | Defined path through the study for a subject | ||
| 0..1 | id | Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily | ||
| 1..1 | string | Label for study comparisonGroup | ||
| 0..1 | CodeableConcept | Categorization of study comparisonGroup Binding: Research Study Arm Type (Extensible) | ||
| 0..1 | markdown | Short explanation of study path | ||
| 0..* | Reference(EvidenceVariable) | Interventions or exposures in this comparisonGroup or cohort | ||
| 0..1 | Reference(Group) | Group of participants who were enrolled in study comparisonGroup | ||
| 0..* | BackboneElement | A goal for the study | ||
| 0..1 | string | Label for the objective | ||
| 0..1 | CodeableConcept | primary | secondary | exploratory Binding: Research Study Objective Type (Preferred) | ||
| 0..1 | markdown | Description of the objective | ||
| 0..* | BackboneElement | A variable measured during the study | ||
| 0..1 | string | Label for the outcome | ||
| 0..* | CodeableConcept | primary | secondary | exploratory Binding: Research Study Objective Type (Preferred) | ||
| 0..1 | markdown | Description of the outcome | ||
| 0..1 | Reference(EvidenceVariable) | Structured outcome definition | ||
| Σ | 0..* | Reference(EvidenceReport | Citation | DiagnosticReport) | Link to results generated during the study | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Participant or object which is the recipient of investigative activities in a study Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business Identifier for research subject in a study | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| 0..* | BackboneElement | Subject status | ||
| 0..1 | CodeableConcept | state | milestone Binding: Research Subject State Type (Example) | ||
| 0..1 | CodeableConcept | candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn Binding: Research Subject State (Required) | ||
| 0..1 | CodeableConcept | SignedUp | Screened | Randomized Binding: Research Subject Milestone (Example) | ||
| 0..1 | CodeableConcept | State change reason Binding: StateChangeReason (Example) | ||
| 0..1 | dateTime | State change date | ||
| 0..1 | dateTime | State change date | ||
| Σ | 0..1 | Period | Start and end of participation | |
| Σ | 1..1 | Reference(ResearchStudy) | Study subject is part of | |
| Σ | 1..1 | Reference(Patient | Group | Specimen | Device | Medication | Substance | BiologicallyDerivedProduct) | Who or what is part of study | |
| 0..1 | id | What path should be followed | ||
| 0..1 | id | What path was followed | ||
| 0..* | Reference(Consent) | Agreement to participate in study | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Potential outcomes for a subject with likelihood Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique identifier for the assessment | |
| 0..1 | Reference(Any) | Request fulfilled by this assessment | ||
| 0..1 | Reference(Any) | Part of this occurrence | ||
| Σ | 1..1 | code | registered | preliminary | final | amended + Binding: Observation Status (Required) | |
| Σ | 0..1 | CodeableConcept | Evaluation mechanism Binding: RiskAssessmentMethod (Example) | |
| Σ | 0..1 | CodeableConcept | Type of assessment | |
| Σ | 1..1 | Reference(Patient | Group) | Who/what does assessment apply to? | |
| Σ | 0..1 | Reference(Encounter) | Where was assessment performed? | |
| Σ | 0..1 | When was assessment made? | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | Reference(Condition) | Condition assessed | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who did assessment? | |
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the assessment was necessary? | ||
| 0..* | Reference(Any) | Information used in assessment | ||
| C | 0..* | BackboneElement | Outcome predicted + Rule: Probability as a deciml must be <= 100 | |
| 0..1 | CodeableConcept | Possible outcome for the subject Binding: RiskAssessmentOutcome (Example) | ||
| C | 0..1 | Likelihood of specified outcome + Rule: low and high must be percentages, if present | ||
| decimal | ||||
| Range | ||||
| 0..1 | CodeableConcept | Likelihood of specified outcome as a qualitative value Binding: Risk Probability (Example) | ||
| 0..1 | decimal | Relative likelihood | ||
| 0..1 | Timeframe or age range | |||
| Period | ||||
| Range | ||||
| 0..1 | string | Explanation of prediction | ||
| 0..1 | string | How to reduce risk | ||
| 0..* | Annotation | Comments on the risk assessment | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A container for slots of time that may be available for booking appointments Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this item | |
| ?!Σ | 0..1 | boolean | Whether this schedule is in active use | |
| Σ | 0..* | CodeableConcept | High-level category Binding: Service Category (Example) | |
| Σ | 0..* | CodeableReference(HealthcareService) | Specific service Binding: Service Type (Example) | |
| Σ | 0..* | CodeableConcept | Type of specialty needed Binding: Practice Setting Code Value Set (Preferred) | |
| Σ | 0..1 | string | Human-readable label | |
| Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | Resource(s) that availability information is being provided for | |
| Σ | 0..1 | Period | Period of time covered by schedule | |
| 0..1 | markdown | Comments on availability | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | Search parameter for a resource + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: If an expression is present, there SHALL be a processingMode + Rule: Search parameters can only have chain names when the search parameter type is 'reference' + Rule: Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'. Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||||||
| ΣC | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |||||
| Σ | 0..* | Identifier | Additional identifier for the search parameter (business identifier) | |||||
| Σ | 0..1 | string | Business version of the search parameter | |||||
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| ΣC | 1..1 | string | Name for this search parameter (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this search parameter (human friendly) | |||||
| 0..1 | canonical(SearchParameter) | Original definition for the search parameter | ||||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
| Σ | 0..1 | dateTime | Date last changed | |||||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| ΣT | 1..1 | markdown | Natural language description of the search parameter | |||||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| T | 0..1 | markdown | Why this search parameter is defined | |||||
| T | 0..1 | markdown | Use and/or publishing restrictions | |||||
| T | 0..1 | string | Copyright holder and year(s) | |||||
| Σ | 1..1 | code | Recommended name for parameter in search url | |||||
| Σ | 1..* | code | The resource type(s) this search parameter applies to Binding: Version Independent Resource Types (All) (Required)
| |||||
| ΣC | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (Required) | |||||
| C | 0..1 | string | FHIRPath expression that extracts the values | |||||
| C | 0..1 | code | normal | phonetic | other Binding: Search Processing Mode Type (Required) | |||||
| 0..1 | string | FHIRPath expression that constraints the usage of this SearchParamete | ||||||
| 0..* | code | Types of resource (if a resource reference) Binding: Version Independent Resource Types (All) (Required)
| ||||||
| 0..1 | boolean | Allow multiple values per parameter (or) | ||||||
| 0..1 | boolean | Allow multiple parameters (and) | ||||||
| C | 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: Search Comparator (Required) | |||||
| 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate Binding: Search Modifier Code (Required) | ||||||
| C | 0..* | string | Chained names supported | |||||
| 0..* | BackboneElement | For Composite resources to define the parts | ||||||
| 1..1 | canonical(SearchParameter) | Defines how the part works | ||||||
| 1..1 | string | Subexpression relative to main expression | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A request for a service to be performed + Rule: bodyStructure SHALL only be present if bodySite is not present + Rule: orderDetail SHALL only be present if code is present Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifiers assigned to this order | |
| Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |
| Σ | 0..* | uri | Instantiates external protocol or definition | |
| Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |
| Σ | 0..* | Reference(ServiceRequest) | What request replaces | |
| Σ | 0..1 | Identifier | Composite Request ID | |
| ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (Required) | |
| ?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (Required) | |
| Σ | 0..* | CodeableConcept | Classification of service Binding: Service Request Category Codes (Example) | |
| Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | |
| ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | |
| ΣC | 0..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: Procedure Codes (SNOMED CT) (Example) | |
| ΣC | 0..* | BackboneElement | Additional order information | |
| 0..1 | CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) | The context of the order details by reference | ||
| Σ | 1..* | BackboneElement | The parameter details for the service being requested | |
| Σ | 1..1 | CodeableConcept | The detail of the order being requested Binding: Servicerequest OrderDetail Parameter Code (Example) | |
| Σ | 1..1 | The value for the order detail | ||
| Quantity | ||||
| Ratio | ||||
| Range | ||||
| boolean | ||||
| CodeableConcept | ||||
| string | ||||
| Period | ||||
| Σ | 0..1 | Service amount | ||
| Quantity | ||||
| Ratio | ||||
| Range | ||||
| Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
| Σ | 0..* | Reference(Any) | What the service request is about, when it is not about the subject of record | |
| Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | |
| Σ | 0..1 | When service should occur | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| Σ | 0..1 | Preconditions for service Binding: SNOMED CT Medication As Needed Reason Codes (Example) | ||
| boolean | ||||
| CodeableConcept | ||||
| Σ | 0..1 | dateTime | Date request signed | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |
| Σ | 0..1 | CodeableConcept | Performer role Binding: Participant Roles (Example) | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
| Σ | 0..* | CodeableReference(Location) | Requested location Binding: ServiceDeliveryLocationRoleType (Example) | |
| Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service Binding: Procedure Reason Codes (Example) | |
| 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||
| 0..* | CodeableReference(Any) | Additional clinical information | ||
| Σ | 0..* | Reference(Specimen) | Procedure Samples | |
| ΣC | 0..* | CodeableConcept | Coded location on Body Binding: SNOMED CT Body Structures (Example) | |
| ΣC | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | |
| 0..* | Annotation | Comments | ||
| 0..* | BackboneElement | Patient or consumer-oriented instructions | ||
| Σ | 0..1 | Patient or consumer-oriented instructions | ||
| markdown | ||||
| Reference(DocumentReference) | ||||
| 0..* | Reference(Provenance) | Request provenance | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A slot of time on a schedule that may be available for booking appointments Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this item | |
| Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: Service Category (Example) | |
| Σ | 0..* | CodeableReference(HealthcareService) | The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the Schedule resource Binding: Service Type (Example) | |
| Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Practice Setting Code Value Set (Preferred) | |
| Σ | 0..* | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (Preferred) | |
| Σ | 1..1 | Reference(Schedule) | The schedule resource that this slot defines an interval of status information | |
| Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: Slot Status (Required) | |
| Σ | 1..1 | instant | Date/Time that the slot is to begin | |
| Σ | 1..1 | instant | Date/Time that the slot is to conclude | |
| 0..1 | boolean | This slot has already been overbooked, appointments are unlikely to be accepted for this time | ||
| 0..1 | string | Comments on the slot to describe any extended information. Such as custom constraints on the slot | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Sample for analysis Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Identifier | |
| Σ | 0..1 | Identifier | Identifier assigned by the lab | |
| ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: Specimen Status (Required) | |
| Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (Example) | |
| Σ | 0..1 | Reference(Patient | Group | Device | BiologicallyDerivedProduct | Substance | Location) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device | |
| Σ | 0..1 | dateTime | The time when specimen is received by the testing laboratory | |
| 0..* | Reference(Specimen) | Specimen from which this specimen originated | ||
| 0..* | Reference(ServiceRequest) | Why the specimen was collected | ||
| Σ | 0..1 | code | grouped | pooled Binding: Specimen Combined (Required) | |
| 0..* | CodeableConcept | The role the specimen serves Binding: Specimen Role (Preferred) | ||
| 0..* | BackboneElement | The physical feature of a specimen | ||
| 1..1 | CodeableConcept | Highlighted feature Binding: SNOMED CT Body Structures (Example) | ||
| 1..1 | string | Information about the feature | ||
| 0..1 | BackboneElement | Collection details | ||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who collected the specimen | |
| Σ | 0..1 | Collection time | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | Duration | How long it took to collect specimen | |
| 0..1 | SimpleQuantity | The quantity of specimen collected | ||
| 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (Example) | ||
| 0..1 | CodeableReference(Device) | Device used to perform collection Binding: SpecimenCollectionDevice (Example) | ||
| 0..1 | Reference(Procedure) | The procedure that collects the specimen | ||
| 0..1 | CodeableReference(BodyStructure) | Anatomical collection site Binding: SNOMED CT Body Structures (Example) | ||
| Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (Extensible) | ||
| CodeableConcept | ||||
| Duration | ||||
| 0..* | BackboneElement | Processing and processing step details | ||
| 0..1 | string | Textual description of procedure | ||
| 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: Specimen Processing Method (Example) | ||
| 0..* | Reference(Substance) | Material used in the processing step | ||
| 0..1 | Date and time of specimen processing | |||
| dateTime | ||||
| Period | ||||
| 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | ||
| 1..1 | Reference(Device) | Device resource for the container | ||
| 0..1 | Reference(Location) | Where the container is | ||
| 0..1 | SimpleQuantity | Quantity of specimen within container | ||
| Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (Extensible) | |
| 0..* | Annotation | Comments | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Kind of specimen Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||
| Σ | 0..1 | uri | Logical canonical URL to reference this SpecimenDefinition (globally unique) | |
| Σ | 0..1 | Identifier | Business identifier | |
| Σ | 0..1 | string | Business version of the SpecimenDefinition | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| Σ | 0..1 | string | Name for this {{title}} (computer friendly) | |
| ΣT | 0..1 | string | Name for this SpecimenDefinition (Human friendly) | |
| Σ | 0..* | canonical(SpecimenDefinition) | Based on FHIR definition of another SpecimenDefinition | |
| Σ | 0..* | uri | Based on external definition | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | If this SpecimenDefinition is not for real usage | |
| Σ | 0..1 | Type of subject for specimen collection | ||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | dateTime | Date status first applied | |
| ΣT | 0..1 | string | The name of the individual or organization that published the SpecimenDefinition | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the SpecimenDefinition | |
| 0..* | UsageContext | Content intends to support these contexts | ||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for this SpecimenDefinition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this SpecimenDefinition is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..1 | date | When SpecimenDefinition was approved by publisher | ||
| 0..1 | date | The date on which the asset content was last reviewed by the publisher | ||
| Σ | 0..1 | Period | The effective date range for the SpecimenDefinition | |
| Σ | 0..1 | CodeableConcept | Kind of material to collect Binding: hl7VS-specimenType (Example) | |
| Σ | 0..* | CodeableConcept | Patient preparation for collection Binding: Patient preparation prior specimen collection (Example) | |
| Σ | 0..1 | string | Time aspect for collection | |
| Σ | 0..* | CodeableConcept | Specimen collection procedure Binding: Specimen collection methods (Example) | |
| 0..* | BackboneElement | Specimen in container intended for testing by lab | ||
| 0..1 | boolean | Primary or secondary specimen | ||
| 0..1 | CodeableConcept | Type of intended specimen Binding: hl7VS-specimenType (Example) | ||
| 1..1 | code | preferred | alternate Binding: Specimen Contained Preference (Required) | ||
| 0..1 | BackboneElement | The specimen's container | ||
| 0..1 | CodeableConcept | The material type used for the container Binding: Types of material for specimen containers (Example) | ||
| 0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: Specimen Container Type (Example) | ||
| 0..1 | CodeableConcept | Color of container cap Binding: Container Cap (Example) | ||
| 0..1 | markdown | The description of the kind of container | ||
| 0..1 | SimpleQuantity | The capacity of this kind of container | ||
| 0..1 | Minimum volume | |||
| SimpleQuantity | ||||
| string | ||||
| 0..* | BackboneElement | Additive associated with container | ||
| 1..1 | Additive associated with container Binding: hl7VS-additivePreservative (Example) | |||
| CodeableConcept | ||||
| Reference(SubstanceDefinition) | ||||
| 0..1 | markdown | Special processing applied to the container for this specimen type | ||
| 0..1 | markdown | Requirements for specimen delivery and special handling | ||
| 0..1 | Duration | The usual time for retaining this kind of specimen | ||
| 0..1 | boolean | Specimen for single use only | ||
| 0..* | CodeableConcept | Criterion specified for specimen rejection Binding: Rejection Criterion (Example) | ||
| 0..* | BackboneElement | Specimen handling before testing | ||
| 0..1 | CodeableConcept | Qualifies the interval of temperature Binding: Handling Condition Set (Example) | ||
| 0..1 | Range | Temperature range for these handling instructions | ||
| 0..1 | Duration | Maximum preservation time | ||
| 0..1 | markdown | Preservation instruction | ||
| 0..* | CodeableConcept | Where the specimen will be tested Binding: Diagnostic Service Section Codes (Example) | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| N | DomainResource | Structural Definition + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Element paths must be unique unless the structure is a constraint + Rule: If the structure is not abstract, then there SHALL be a baseDefinition + Rule: If the structure defines an extension then the structure must have context information + Rule: A structure must have either a differential, or a snapshot (or both) + Rule: If there's a type, its content must match the path name in the first element of a snapshot + Rule: All element definitions must have an id + Rule: The first element in a snapshot has no type unless model is a logical model. + Rule: If the first element in a differential has no "." in the path and it's not a logical model, it has no type + Rule: In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element) + Rule: All element definitions must have unique ids (snapshot) + Rule: All element definitions must have unique ids (diff) + Rule: Context Invariants can only be used for extensions + Rule: FHIR Specification models only use FHIR defined types + Rule: Default values can only be specified on specializations + Rule: FHIR Specification models never have default values + Rule: No slice name on root + Rule: If there's a base definition, there must be a derivation + Warning: Elements in Resources must have a min cardinality or 0 or 1 and a max cardinality of 1 or * Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the structure definition | |
| Σ | 0..1 | string | Business version of the structure definition | |
| ΣTU | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 1..1 | string | Name for this structure definition (computer friendly) | |
| ΣT | 0..1 | string | Name for this structure definition (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the structure definition | |
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this structure definition is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| TTU | 0..1 | string | Copyright holder and year(s) | |
| ΣXD | 0..* | Coding | Assist with indexing and finding Binding: Structure Definition Use Codes / Keywords (Extensible) | |
| Σ | 0..1 | code | FHIR Version this StructureDefinition targets Binding: FHIRVersion (Required) | |
| C | 0..* | BackboneElement | External specification that the content is mapped to + Rule: Must have at least a name or a uri (or both) | |
| 1..1 | id | Internal id when this mapping is used | ||
| C | 0..1 | uri | Identifies what this mapping refers to | |
| C | 0..1 | string | Names what this mapping refers to | |
| 0..1 | string | Versions, Issues, Scope limitations etc | ||
| ΣC | 1..1 | code | primitive-type | complex-type | resource | logical Binding: Structure Definition Kind (Required) | |
| ΣC | 1..1 | boolean | Whether the structure is abstract | |
| ΣC | 0..* | BackboneElement | If an extension, where it can be used in instances | |
| Σ | 1..1 | code | fhirpath | element | extension Binding: Extension Context Type (Required) | |
| Σ | 1..1 | string | Where the extension can be used in instances | |
| ΣC | 0..* | string | FHIRPath invariants - when the extension can be used | |
| ΣC | 1..1 | uri | Type defined or constrained by this structure Binding: All FHIR Types (Extensible) | |
| ΣC | 0..1 | canonical(StructureDefinition) | Definition that this type is constrained/specialized from | |
| ΣC | 0..1 | code | specialization | constraint - How relates to base definition Binding: Type Derivation Rule (Required) | |
| C | 0..1 | BackboneElement | Snapshot view of the structure + Rule: Each element definition in a snapshot must have a formal definition and cardinalities, unless model is a logical model + Rule: All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models + Rule: For CodeableReference elements, target profiles must be listed on the CodeableReference, not the CodeableReference.reference + Rule: For CodeableReference elements, bindings must be listed on the CodeableReference, not the CodeableReference.concept + Guideline: The root element of a profile should not have mustSupport = true + Rule: All snapshot elements must have a base definition | |
| C | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) + Rule: provide either a binding reference or a description (or both) + Rule: If there are no discriminators, there must be a definition | |
| C | 0..1 | BackboneElement | Differential view of the structure + Rule: No slicing on the root element + Rule: In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models | |
| C | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A Map of relationships between 2 structures that can be used to transform data + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 1..1 | uri | Canonical identifier for this structure map, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the structure map | |
| Σ | 0..1 | string | Business version of the structure map | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 1..1 | string | Name for this structure map (computer friendly) | |
| ΣT | 0..1 | string | Name for this structure map (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the structure map | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for structure map (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this structure map is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| Σ | 0..* | BackboneElement | Structure Definition used by this map | |
| Σ | 1..1 | canonical(StructureDefinition) | Canonical reference to structure definition | |
| Σ | 1..1 | code | source | queried | target | produced Binding: Structure Map Model Mode (Required) | |
| Σ | 0..1 | string | Name for type in this map | |
| 0..1 | string | Documentation on use of structure | ||
| Σ | 0..* | canonical(StructureMap) | Other maps used by this map (canonical URLs) | |
| Σ | 0..* | BackboneElement | Definition of the constant value used in the map rules | |
| Σ | 0..1 | id | Constant name | |
| Σ | 0..1 | string | FHIRPath exression - value of the constant | |
| Σ | 1..* | BackboneElement | Named sections for reader convenience | |
| Σ | 1..1 | id | Human-readable label | |
| Σ | 0..1 | id | Another group that this group adds rules to | |
| Σ | 0..1 | code | types | type-and-types Binding: Structure Map Group Type Mode (Required) | |
| Σ | 0..1 | string | Additional description/explanation for group | |
| Σ | 1..* | BackboneElement | Named instance provided when invoking the map | |
| Σ | 1..1 | id | Name for this instance of data | |
| Σ | 0..1 | string | Type for this instance of data | |
| Σ | 1..1 | code | source | target Binding: Structure Map Input Mode (Required) | |
| 0..1 | string | Documentation for this instance of data | ||
| Σ | 0..* | BackboneElement | Transform Rule from source to target | |
| Σ | 0..1 | id | Name of the rule for internal references | |
| Σ | 1..* | BackboneElement | Source inputs to the mapping | |
| Σ | 1..1 | id | Type or variable this rule applies to | |
| Σ | 0..1 | integer | Specified minimum cardinality | |
| Σ | 0..1 | string | Specified maximum cardinality (number or *) | |
| Σ | 0..1 | string | Rule only applies if source has this type | |
| Σ | 0..1 | string | Default value if no value exists | |
| Σ | 0..1 | string | Optional field for this source | |
| Σ | 0..1 | code | first | not_first | last | not_last | only_one Binding: Structure Map Source List Mode (Required) | |
| Σ | 0..1 | id | Named context for field, if a field is specified | |
| Σ | 0..1 | string | FHIRPath expression - must be true or the rule does not apply | |
| Σ | 0..1 | string | FHIRPath expression - must be true or the mapping engine throws an error instead of completing | |
| Σ | 0..1 | string | Message to put in log if source exists (FHIRPath) | |
| ΣC | 0..* | BackboneElement | Content to create because of this mapping rule + Rule: Can only have an element if you have a context | |
| ΣC | 0..1 | string | Variable this rule applies to | |
| ΣC | 0..1 | string | Field to create in the context | |
| Σ | 0..1 | id | Named context for field, if desired, and a field is specified | |
| Σ | 0..* | code | first | share | last | single Binding: Structure Map Target List Mode (Required) | |
| Σ | 0..1 | id | Internal rule reference for shared list items | |
| Σ | 0..1 | code | create | copy + Binding: Structure Map Transform (Required) | |
| Σ | 0..* | BackboneElement | Parameters to the transform | |
| Σ | 1..1 | Parameter value - variable or literal | ||
| id | ||||
| string | ||||
| boolean | ||||
| integer | ||||
| decimal | ||||
| date | ||||
| time | ||||
| dateTime | ||||
| Σ | 0..* | see rule | Rules contained in this rule | |
| Σ | 0..* | BackboneElement | Which other rules to apply in the context of this rule | |
| Σ | 1..1 | id | Name of a rule or group to apply | |
| Σ | 1..* | see parameter | Parameter to pass to the rule or group | |
| 0..1 | string | Documentation for this instance of data | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | Notification about a SubscriptionTopic Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | Additional identifiers (business identifier) | |||||
| Σ | 0..1 | string | Human readable name for this subscription | |||||
| ?!Σ | 1..1 | code | requested | active | error | off | entered-in-error Binding: Subscription Status (Required) | |||||
| Σ | 1..1 | canonical(SubscriptionTopic) | Reference to the subscription topic being subscribed to | |||||
| Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
| Σ | 0..1 | instant | When to automatically delete the subscription | |||||
| Σ | 0..1 | Reference(CareTeam | HealthcareService | Organization | RelatedPerson | Patient | Practitioner | PractitionerRole) | Entity responsible for Subscription changes | |||||
| Σ | 0..1 | string | Description of why this subscription was created | |||||
| ΣC | 0..* | BackboneElement | Criteria for narrowing the subscription topic stream + Rule: Subscription filters may only contain a modifier or a comparator | |||||
| Σ | 0..1 | uri | Allowed Resource (reference to definition) for this Subscription filter Binding: Types used with Subscriptions (Extensible)
| |||||
| Σ | 1..1 | string | Filter label defined in SubscriptionTopic | |||||
| C | 0..1 | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: Search Comparator (Required) | |||||
| C | 0..1 | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate Binding: Search Modifier Code (Required) | |||||
| Σ | 1..1 | string | Literal value or resource path | |||||
| Σ | 1..1 | Coding | Channel type for notifications Binding: Subscription Channel Type (Extensible) | |||||
| Σ | 0..1 | url | Where the channel points to | |||||
| 0..* | BackboneElement | Channel type | ||||||
| 1..1 | string | Name (key) of the parameter | ||||||
| 1..1 | string | Value of the parameter to use or pass through | ||||||
| Σ | 0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification | |||||
| Σ | 0..1 | unsignedInt | Timeout in seconds to attempt notification delivery | |||||
| Σ | 0..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (Required) | |||||
| Σ | 0..1 | code | empty | id-only | full-resource Binding: Subscription Payload Content (Required) | |||||
| Σ | 0..1 | positiveInt | Maximum number of events that can be combined in a single notification | |||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Status information about a Subscription provided during event notification + Rule: Event notifications must contain events + Rule: Status messages must contain status Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| ΣC | 0..1 | code | requested | active | error | off | entered-in-error Binding: Subscription Status (Required) | |
| ?!ΣC | 1..1 | code | handshake | heartbeat | event-notification | query-status | query-event Binding: Subscription Notification Type (Required) | |
| Σ | 0..1 | integer64 | Events since the Subscription was created | |
| C | 0..* | BackboneElement | Detailed information about any events relevant to this notification | |
| 1..1 | integer64 | Sequencing index of this event | ||
| 0..1 | instant | The instant this event occurred | ||
| 0..1 | Reference(Any) | Reference to the primary resource or information of this event | ||
| 0..* | Reference(Any) | References related to the focus resource and/or context of this event | ||
| Σ | 1..1 | Reference(Subscription) | Reference to the Subscription responsible for this notification | |
| Σ | 0..1 | canonical(SubscriptionTopic) | Reference to the SubscriptionTopic this notification relates to | |
| Σ | 0..* | CodeableConcept | List of errors on the subscription Binding: Subscription Error Codes (Example) | |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | The definition of a specific topic for triggering events within the Subscriptions framework Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||||||
| Σ | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) | |||||
| Σ | 0..* | Identifier | Business identifier for subscription topic | |||||
| Σ | 0..1 | string | Business version of the subscription topic | |||||
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| Σ | 0..1 | string | Name for this subscription topic (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this subscription topic (human friendly) | |||||
| Σ | 0..* | canonical(SubscriptionTopic) | Based on FHIR protocol or definition | |||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| Σ | 0..1 | boolean | If for testing purposes, not real usage | |||||
| Σ | 0..1 | dateTime | Date status first applied | |||||
| ΣT | 0..1 | string | The name of the individual or organization that published the SubscriptionTopic | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| T | 0..1 | markdown | Natural language description of the SubscriptionTopic | |||||
| Σ | 0..* | UsageContext | Content intends to support these contexts | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction of the SubscriptionTopic (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| T | 0..1 | markdown | Why this SubscriptionTopic is defined | |||||
| T | 0..1 | markdown | Use and/or publishing restrictions | |||||
| T | 0..1 | string | Copyright holder and year(s) | |||||
| 0..1 | date | When SubscriptionTopic is/was approved by publisher | ||||||
| 0..1 | date | Date the Subscription Topic was last reviewed by the publisher | ||||||
| Σ | 0..1 | Period | The effective date range for the SubscriptionTopic | |||||
| Σ | 0..* | BackboneElement | Definition of a resource-based trigger for the subscription topic | |||||
| Σ | 0..1 | markdown | Text representation of the resource trigger | |||||
| Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: Types used with Subscriptions (Extensible)
| |||||
| Σ | 0..* | code | create | update | delete Binding: Interaction Trigger (Required) | |||||
| Σ | 0..1 | BackboneElement | Query based trigger rule | |||||
| Σ | 0..1 | string | Rule applied to previous resource state | |||||
| Σ | 0..1 | code | test-passes | test-fails Binding: Criteria Not Exists Behavior (Required) | |||||
| Σ | 0..1 | string | Rule applied to current resource state | |||||
| Σ | 0..1 | code | test-passes | test-fails Binding: Criteria Not Exists Behavior (Required) | |||||
| Σ | 0..1 | boolean | Both must be true flag | |||||
| Σ | 0..1 | string | FHIRPath based trigger rule | |||||
| Σ | 0..* | BackboneElement | Event definitions the SubscriptionTopic | |||||
| Σ | 0..1 | markdown | Text representation of the event trigger | |||||
| Σ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: hl7VS-eventTypeCode (Example) | |||||
| Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: Types used with Subscriptions (Extensible)
| |||||
| Σ | 0..* | BackboneElement | Properties by which a Subscription can filter notifications from the SubscriptionTopic | |||||
| Σ | 0..1 | markdown | Description of this filter parameter | |||||
| Σ | 0..1 | uri | URL of the triggering Resource that this filter applies to Binding: Types used with Subscriptions (Extensible)
| |||||
| Σ | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter | |||||
| Σ | 0..1 | uri | Canonical URL for a filterParameter definition | |||||
| 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: Search Comparator (Required) | ||||||
| 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate Binding: Search Modifier Code (Required) | ||||||
| Σ | 0..* | BackboneElement | Properties for describing the shape of notifications generated by this topic | |||||
| Σ | 1..1 | uri | URL of the Resource that is the focus (main) resource in a notification shape Binding: Types used with Subscriptions (Extensible)
| |||||
| Σ | 0..* | string | Include directives, rooted in the resource for this shape | |||||
| Σ | 0..* | string | Reverse include directives, rooted in the resource for this shape | |||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A homogeneous material with a definite composition Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique identifier | |
| ?!Σ | 1..1 | boolean | Is this an instance of a substance or a kind of one | |
| ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (Required) | |
| Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: Substance Category Codes (Extensible) | |
| Σ | 1..1 | CodeableReference(SubstanceDefinition) | What substance this is Binding: Substance Code (Example) | |
| Σ | 0..1 | markdown | Textual description of the substance, comments | |
| Σ | 0..1 | dateTime | When no longer valid to use | |
| Σ | 0..1 | SimpleQuantity | Amount of substance in the package | |
| Σ | 0..* | BackboneElement | Composition information about the substance | |
| Σ | 0..1 | Ratio | Optional amount (concentration) | |
| Σ | 1..1 | A component of the substance Binding: Substance Code (Example) | ||
| CodeableConcept | ||||
| Reference(Substance) | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TU | DomainResource | The detailed description of a substance, typically at a level beyond what is used for prescribing Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||||||
| Σ | 0..* | Identifier | Identifier by which this substance is known | |||||
| Σ | 0..1 | string | A business level version identifier of the substance | |||||
| Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. active, retired Binding: PublicationStatus (Preferred) | |||||
| Σ | 0..* | CodeableConcept | A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity | |||||
| Σ | 0..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: Medicinal Product Domain (Example) | |||||
| Σ | 0..* | CodeableConcept | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) Binding: Substance Grade (Example) | |||||
| Σ | 0..1 | markdown | Textual description of the substance | |||||
| Σ | 0..* | Reference(Citation) | Supporting literature | |||||
| Σ | 0..* | Annotation | Textual comment about the substance's catalogue or registry record | |||||
| Σ | 0..* | Reference(Organization) | The entity that creates, makes, produces or fabricates the substance | |||||
| Σ | 0..* | Reference(Organization) | An entity that is the source for the substance. It may be different from the manufacturer | |||||
| Σ | 0..* | BackboneElement | Moiety, for structural modifications | |||||
| Σ | 0..1 | CodeableConcept | Role that the moiety is playing | |||||
| Σ | 0..1 | Identifier | Identifier by which this moiety substance is known | |||||
| Σ | 0..1 | string | Textual name for this moiety substance | |||||
| Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (Example) | |||||
| Σ | 0..1 | CodeableConcept | Optical activity type Binding: Optical Activity (Example) | |||||
| Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system) | |||||
| Σ | 0..1 | Quantitative value for this moiety | ||||||
| Quantity | ||||||||
| string | ||||||||
| Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: Substance Amount Type (Example) | |||||
| Σ | 0..* | BackboneElement | General specifications for this substance | |||||
| Σ | 0..1 | CodeableConcept | The method used to find the characterization e.g. HPLC Binding: Structure Technique (Example) | |||||
| Σ | 0..1 | CodeableConcept | Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form Binding: Substance Form (Example) | |||||
| Σ | 0..1 | markdown | The description or justification in support of the interpretation of the data file | |||||
| Σ | 0..* | Attachment | The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis | |||||
| Σ | 0..* | BackboneElement | General specifications for this substance | |||||
| Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: Product Characteristic (Example) | |||||
| Σ | 0..1 | A value for the property | ||||||
| CodeableConcept | ||||||||
| Quantity | ||||||||
| date | ||||||||
| boolean | ||||||||
| Attachment | ||||||||
| Σ | 0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance | |||||
| Σ | 0..* | BackboneElement | The average mass of a molecule of a compound | |||||
| Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: Weight Method (Example) | |||||
| Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: Weight Type (Example) | |||||
| Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements | |||||
| Σ | 0..1 | BackboneElement | Structural information | |||||
| Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (Example) | |||||
| Σ | 0..1 | CodeableConcept | Optical activity type Binding: Optical Activity (Example) | |||||
| Σ | 0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance | |||||
| Σ | 0..1 | string | Specified per moiety according to the Hill system | |||||
| Σ | 0..1 | see molecularWeight | The molecular weight or weight range | |||||
| Σ | 0..* | CodeableConcept | The method used to find the structure e.g. X-ray, NMR Binding: Structure Technique (Example) | |||||
| Σ | 0..* | Reference(DocumentReference) | Source of information for the structure | |||||
| Σ | 0..* | BackboneElement | A depiction of the structure of the substance | |||||
| Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Substance Representation Type (Example) | |||||
| Σ | 0..1 | string | The structural representation as a text string in a standard format | |||||
| Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: Substance Representation Format (Example) | |||||
| Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | |||||
| Σ | 0..* | BackboneElement | Codes associated with the substance | |||||
| Σ | 0..1 | CodeableConcept | The specific code | |||||
| Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (Preferred) | |||||
| Σ | 0..1 | dateTime | The date at which the code status was changed | |||||
| Σ | 0..* | Annotation | Any comment can be provided in this field | |||||
| Σ | 0..* | Reference(DocumentReference) | Supporting literature | |||||
| Σ | 0..* | BackboneElement | Names applicable to this substance | |||||
| Σ | 1..1 | string | The actual name | |||||
| Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (Example) | |||||
| Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (Preferred) | |||||
| Σ | 0..1 | boolean | If this is the preferred name for this substance | |||||
| Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: All Languages (Required)
| |||||
| Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: Substance Name Domain (Example) | |||||
| Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: Jurisdiction ValueSet (Example) | |||||
| Σ | 0..* | see name | A synonym of this particular name, by which the substance is also known | |||||
| Σ | 0..* | see name | A translation for this name into another human language | |||||
| Σ | 0..* | BackboneElement | Details of the official nature of this name | |||||
| Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority (Preferred) | |||||
| Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (Preferred) | |||||
| Σ | 0..1 | dateTime | Date of official name change | |||||
| Σ | 0..* | Reference(DocumentReference) | Supporting literature | |||||
| Σ | 0..* | BackboneElement | A link between this substance and another | |||||
| Σ | 0..1 | A pointer to another substance, as a resource or a representational code | ||||||
| Reference(SubstanceDefinition) | ||||||||
| CodeableConcept | ||||||||
| Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: Substance Relationship Type (Example) | |||||
| Σ | 0..1 | boolean | For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships | |||||
| Σ | 0..1 | A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other | ||||||
| Quantity | ||||||||
| Ratio | ||||||||
| string | ||||||||
| Σ | 0..1 | Ratio | For use when the numeric has an uncertain range | |||||
| Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: Substance Amount Type (Example) | |||||
| Σ | 0..* | Reference(DocumentReference) | Supporting literature | |||||
| Σ | 0..1 | Reference(SubstanceNucleicAcid) | Data items specific to nucleic acids | |||||
| Σ | 0..1 | Reference(SubstancePolymer) | Data items specific to polymers | |||||
| Σ | 0..1 | Reference(SubstanceProtein) | Data items specific to proteins | |||||
| Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source | |||||
| Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: Source Material Type (Example) | |||||
| Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: Source Material Genus (Example) | |||||
| Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: Source Material Species (Example) | |||||
| Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: Source Material Part (Example) | |||||
| Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: Country ValueSet (Required) | |||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | CodeableConcept | The type of the sequence shall be specified based on a controlled vocabulary | |
| Σ | 0..1 | integer | The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit | |
| Σ | 0..1 | string | The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue” | |
| Σ | 0..1 | CodeableConcept | (TBC) | |
| Σ | 0..* | BackboneElement | Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times | |
| Σ | 0..1 | integer | Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts | |
| Σ | 0..1 | string | Actual nucleotide sequence notation from 5' to 3' end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured | |
| Σ | 0..1 | integer | The length of the sequence shall be captured | |
| Σ | 0..1 | Attachment | (TBC) | |
| Σ | 0..1 | CodeableConcept | The nucleotide present at the 5’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant | |
| Σ | 0..1 | CodeableConcept | The nucleotide present at the 3’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant | |
| Σ | 0..* | BackboneElement | The linkages between sugar residues will also be captured | |
| Σ | 0..1 | string | The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified | |
| Σ | 0..1 | Identifier | Each linkage will be registered as a fragment and have an ID | |
| Σ | 0..1 | string | Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage | |
| Σ | 0..1 | string | Residues shall be captured as described in 5.3.6.8.3 | |
| Σ | 0..* | BackboneElement | 5.3.6.8.1 Sugar ID (Mandatory) | |
| Σ | 0..1 | Identifier | The Substance ID of the sugar or sugar-like component that make up the nucleotide | |
| Σ | 0..1 | string | The name of the sugar or sugar-like component that make up the nucleotide | |
| Σ | 0..1 | string | The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Properties of a substance specific to it being a polymer Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | Identifier | A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier | |
| Σ | 0..1 | CodeableConcept | Overall type of the polymer | |
| Σ | 0..1 | CodeableConcept | Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic | |
| Σ | 0..* | CodeableConcept | Descrtibes the copolymer sequence type (polymer connectivity) | |
| Σ | 0..1 | string | Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder | |
| Σ | 0..* | BackboneElement | Todo | |
| Σ | 0..1 | CodeableConcept | Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio | |
| Σ | 0..* | BackboneElement | The starting materials - monomer(s) used in the synthesis of the polymer | |
| Σ | 0..1 | CodeableConcept | The type of substance for this starting material | |
| Σ | 0..1 | CodeableConcept | Substance high level category, e.g. chemical substance | |
| Σ | 0..1 | boolean | Used to specify whether the attribute described is a defining element for the unique identification of the polymer | |
| Σ | 0..1 | Quantity | A percentage | |
| Σ | 0..* | BackboneElement | Specifies and quantifies the repeated units and their configuration | |
| Σ | 0..1 | string | A representation of an (average) molecular formula from a polymer | |
| Σ | 0..1 | CodeableConcept | How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average) | |
| Σ | 0..* | BackboneElement | An SRU - Structural Repeat Unit | |
| Σ | 0..1 | string | Structural repeat units are essential elements for defining polymers | |
| Σ | 0..1 | CodeableConcept | The orientation of the polymerisation, e.g. head-tail, head-head, random | |
| Σ | 0..1 | integer | Number of repeats of this unit | |
| Σ | 0..* | BackboneElement | Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described | |
| Σ | 0..1 | CodeableConcept | The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio | |
| Σ | 0..1 | integer | An average amount of polymerisation | |
| Σ | 0..1 | integer | A low expected limit of the amount | |
| Σ | 0..1 | integer | A high expected limit of the amount | |
| Σ | 0..* | BackboneElement | A graphical structure for this SRU | |
| Σ | 0..1 | CodeableConcept | The type of structure (e.g. Full, Partial, Representative) | |
| Σ | 0..1 | string | The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF | |
| Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF | |
| Σ | 0..1 | Attachment | An attached file with the structural representation | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | CodeableConcept | The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence | |
| Σ | 0..1 | integer | Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable | |
| Σ | 0..* | string | The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions | |
| Σ | 0..* | BackboneElement | This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times | |
| Σ | 0..1 | integer | Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts | |
| Σ | 0..1 | string | The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence | |
| Σ | 0..1 | integer | Length of linear sequences of amino acids contained in the subunit | |
| Σ | 0..1 | Attachment | The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence | |
| Σ | 0..1 | Identifier | Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID | |
| Σ | 0..1 | string | The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified | |
| Σ | 0..1 | Identifier | Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID | |
| Σ | 0..1 | string | The modification at the C-terminal shall be specified | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Todo Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | string | Todo | |
| Σ | 0..* | BackboneElement | Todo | |
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..* | Reference(DocumentReference) | Todo | |
| Σ | 0..* | BackboneElement | Todo | |
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..1 | Identifier | Todo | |
| Σ | 0..* | Reference(DocumentReference) | Todo | |
| Σ | 0..* | BackboneElement | Todo | |
| Σ | 0..1 | Identifier | Todo | |
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..1 | Todo | ||
| Quantity | ||||
| Range | ||||
| string | ||||
| Σ | 0..1 | CodeableConcept | Todo | |
| Σ | 0..* | Reference(DocumentReference) | Todo | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | CodeableConcept | General high level classification of the source material specific to the origin of the material | |
| Σ | 0..1 | CodeableConcept | The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent | |
| Σ | 0..1 | CodeableConcept | The state of the source material when extracted | |
| Σ | 0..1 | Identifier | The unique identifier associated with the source material parent organism shall be specified | |
| Σ | 0..1 | string | The organism accepted Scientific name shall be provided based on the organism taxonomy | |
| Σ | 0..* | Identifier | The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant) | |
| Σ | 0..* | string | The parent substance of the Herbal Drug, or Herbal preparation | |
| Σ | 0..* | CodeableConcept | The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate | |
| Σ | 0..* | string | The place/region where the plant is harvested or the places/regions where the animal source material has its habitat | |
| Σ | 0..1 | CodeableConcept | Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum) | |
| Σ | 0..* | BackboneElement | Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels | |
| Σ | 0..1 | string | This element is capturing information about the fraction of a plant part, or human plasma for fractionation | |
| Σ | 0..1 | CodeableConcept | The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1 | |
| Σ | 0..1 | BackboneElement | This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf | |
| Σ | 0..1 | CodeableConcept | The family of an organism shall be specified | |
| Σ | 0..1 | CodeableConcept | The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies | |
| Σ | 0..1 | CodeableConcept | The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies | |
| Σ | 0..1 | CodeableConcept | The Intraspecific type of an organism shall be specified | |
| Σ | 0..1 | string | The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention | |
| Σ | 0..* | BackboneElement | 4.9.13.6.1 Author type (Conditional) | |
| Σ | 0..1 | CodeableConcept | The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name | |
| Σ | 0..1 | string | The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank) | |
| Σ | 0..1 | BackboneElement | 4.9.13.8.1 Hybrid species maternal organism ID (Optional) | |
| Σ | 0..1 | string | The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal | |
| Σ | 0..1 | string | The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal | |
| Σ | 0..1 | string | The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary | |
| Σ | 0..1 | string | The name of the paternal species constituting the hybrid organism shall be specified | |
| Σ | 0..1 | CodeableConcept | The hybrid type of an organism shall be specified | |
| Σ | 0..1 | BackboneElement | 4.9.13.7.1 Kingdom (Conditional) | |
| Σ | 0..1 | CodeableConcept | The kingdom of an organism shall be specified | |
| Σ | 0..1 | CodeableConcept | The phylum of an organism shall be specified | |
| Σ | 0..1 | CodeableConcept | The class of an organism shall be specified | |
| Σ | 0..1 | CodeableConcept | The order of an organism shall be specified, | |
| Σ | 0..* | BackboneElement | To do | |
| Σ | 0..1 | CodeableConcept | Entity of anatomical origin of source material within an organism | |
| Σ | 0..1 | CodeableConcept | The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Delivery of bulk Supplies Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | External identifier | ||
| Σ | 0..* | Reference(SupplyRequest) | Fulfills plan, proposal or order | |
| Σ | 0..* | Reference(SupplyDelivery | Contract) | Part of referenced event | |
| ?!Σ | 0..1 | code | in-progress | completed | abandoned | entered-in-error Binding: Supply Delivery Status (Required) | |
| 0..1 | Reference(Patient) | Patient for whom the item is supplied | ||
| 0..1 | CodeableConcept | Category of supply event Binding: Supply Delivery Supply Item Type (Required) | ||
| 0..* | BackboneElement | The item that is delivered or supplied | ||
| 0..1 | SimpleQuantity | Amount supplied | ||
| 0..1 | Medication, Substance, Device or Biologically Derived Product supplied Binding: Supply Delivery Supply Item Type (Example) | |||
| CodeableConcept | ||||
| Reference(Medication | Substance | Device | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) | ||||
| Σ | 0..1 | When event occurred | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The item supplier | ||
| 0..1 | Reference(Location) | Where the delivery was sent | ||
| 0..* | Reference(Practitioner | PractitionerRole | Organization) | Who received the delivery | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Request for a medication, substance or device Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Business Identifier for SupplyRequest | |
| ?!Σ | 0..1 | code | draft | active | suspended + Binding: Supply Request Status (Required) | |
| Σ | 0..* | Reference(Any) | What other request is fulfilled by this supply request | |
| Σ | 0..1 | CodeableConcept | The kind of supply (central, non-stock, etc.) Binding: Supply Type (Example) | |
| Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | |
| 0..1 | Reference(Patient) | The patient for who the supply request is for | ||
| Σ | 1..1 | CodeableReference(Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) | Medication, Substance, or Device requested to be supplied Binding: SNOMED CT Supply Item (Example) | |
| Σ | 1..1 | Quantity | The requested amount of the item indicated | |
| 0..* | BackboneElement | Ordered item details | ||
| 0..1 | CodeableConcept | Item detail Binding: ParameterCode (Example) | ||
| 0..1 | Value of detail | |||
| CodeableConcept | ||||
| Quantity | ||||
| Range | ||||
| boolean | ||||
| Σ | 0..1 | When the request should be fulfilled | ||
| dateTime | ||||
| Period | ||||
| Timing | ||||
| Σ | 0..1 | dateTime | When the request was made | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam) | Individual making the request | |
| Σ | 0..* | Reference(Organization | HealthcareService) | Who is intended to fulfill the request | |
| 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | The reason why the supply item was requested Binding: Supply Request Reason (Example) | ||
| 0..1 | Reference(Organization | Location) | The origin of the supply | ||
| 0..1 | Reference(Organization | Location | Patient | RelatedPerson) | The destination of the supply | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A task to be performed + Rule: Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. + Rule: Last modified date must be greater than or equal to authored-on date. Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Task Instance Identifier | ||
| Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | |
| Σ | 0..1 | uri | Formal definition of task | |
| Σ | 0..* | Reference(Any) | Request fulfilled by this task | |
| Σ | 0..1 | Identifier | Requisition or grouper id | |
| Σ | 0..* | Reference(Task) | Composite task | |
| ?!Σ | 1..1 | code | draft | requested | received | accepted | + Binding: Task Status (Required) | |
| Σ | 0..1 | CodeableReference() | Reason for current status Binding: Task Status Reason (Example) | |
| Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: TaskBusinessStatus (Example) | |
| Σ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: Task Intent (Required) | |
| 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | ||
| ?!Σ | 0..1 | boolean | True if Task is prohibiting action | |
| ΣC | 0..1 | CodeableConcept | Task Type Binding: Task Codes (Example) | |
| Σ | 0..1 | string | Human-readable explanation of task | |
| ΣC | 0..1 | Reference(Any) | What task is acting on | |
| Σ | 0..1 | Reference(Any) | Beneficiary of the Task | |
| Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | |
| Σ | 0..1 | Period | When the task should be performed | |
| Σ | 0..1 | Period | Start and end time of execution | |
| C | 0..1 | dateTime | Task Creation Date | |
| ΣC | 0..1 | dateTime | Task Last Modified Date | |
| Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for task to be done | |
| 0..* | CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should perform Task Binding: Procedure Performer Role Codes (Preferred) | ||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Responsible individual | |
| Σ | 0..* | BackboneElement | Who or what performed the task | |
| Σ | 0..1 | CodeableConcept | Type of performance Binding: TaskPerformerFunctionCode (Example) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who performed the task | |
| Σ | 0..1 | Reference(Location) | Where task occurs | |
| 0..* | CodeableReference() | Why task is needed Binding: TaskReason (Example) | ||
| 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||
| 0..* | Annotation | Comments made about the task | ||
| 0..* | Reference(Provenance) | Key events in history of the Task | ||
| C | 0..1 | BackboneElement | Constraints on fulfillment tasks | |
| 0..1 | positiveInt | How many times to repeat | ||
| 0..1 | Period | When fulfillment is sought | ||
| 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | ||
| 0..* | BackboneElement | Information used to perform task | ||
| 1..1 | CodeableConcept | Label for the input Binding: TaskInputParameterType (Example) | ||
| 1..1 | * | Content to use in performing the task | ||
| 0..* | BackboneElement | Information produced as part of task | ||
| 1..1 | CodeableConcept | Label for output Binding: TaskOutputParameterType (Example) | ||
| 1..1 | * | Result of output | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A statement of system capabilities + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: A Terminology Capability statement SHALL have at least one of description, software, or implementation element + Rule: If kind = instance, implementation must be present and software may be present + Rule: If kind = capability, implementation must be absent, software must be present + Rule: If kind = requirements, implementation and software must be absent + Rule: Each instance of the codeSystem element must represent a distinct code system. Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the terminology capabilities | |
| Σ | 0..1 | string | Business version of the terminology capabilities | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this terminology capabilities (computer friendly) | |
| ΣT | 0..1 | string | Name for this terminology capabilities (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 1..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| TC | 0..1 | markdown | Natural language description of the terminology capabilities | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this terminology capabilities is defined | |
| ΣT | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| ΣC | 1..1 | code | instance | capability | requirements Binding: Capability Statement Kind (Required) | |
| ΣC | 0..1 | BackboneElement | Software that is covered by this terminology capability statement | |
| Σ | 1..1 | string | A name the software is known by | |
| Σ | 0..1 | string | Version covered by this statement | |
| ΣC | 0..1 | BackboneElement | If this describes a specific instance | |
| ΣT | 1..1 | string | Describes this specific instance | |
| Σ | 0..1 | url | Base URL for the implementation | |
| Σ | 0..1 | boolean | Whether lockedDate is supported | |
| C | 0..* | BackboneElement | A code system supported by the server + Rule: If there is more than one version, a version code must be defined + Rule: Each version.code element must be distinct for a particular code system. + Rule: A codeSystem element instance may have at most one version.isDefault element with a value of 'true'. | |
| C | 0..1 | canonical(CodeSystem) | Canonical identifier for the code system, represented as a URI | |
| C | 0..* | BackboneElement | Version of Code System supported | |
| ΣC | 0..1 | string | Version identifier for this version | |
| ΣC | 0..1 | boolean | If this is the default version for this code system | |
| 0..1 | boolean | If compositional grammar is supported | ||
| 0..* | code | Language Displays supported Binding: Common Languages (Required) | ||
| 0..* | BackboneElement | Filter Properties supported | ||
| 1..1 | code | Code of the property supported | ||
| 1..* | code | Operations supported for the property | ||
| 0..* | code | Properties supported for $lookup | ||
| Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: Code System Content Mode (Required) | |
| 0..1 | boolean | Whether subsumption is supported | ||
| 0..1 | BackboneElement | Information about the [ValueSet/$expand](valueset-operation-expand.html) operation | ||
| 0..1 | boolean | Whether the server can return nested value sets | ||
| 0..1 | boolean | Whether the server supports paging on expansion | ||
| 0..1 | boolean | Allow request for incomplete expansions? | ||
| 0..* | BackboneElement | Supported expansion parameter | ||
| 1..1 | code | Name of the supported expansion parameter | ||
| 0..1 | string | Description of support for parameter | ||
| 0..1 | markdown | Documentation about text searching works | ||
| 0..1 | code | in-compose | in-expansion | in-compose-or-expansion Binding: Code Search Support (Required) | ||
| 0..1 | BackboneElement | Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation | ||
| 1..1 | boolean | Whether translations are validated | ||
| 0..1 | BackboneElement | Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation | ||
| 1..1 | boolean | Whether the client must identify the map | ||
| 0..1 | BackboneElement | Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation | ||
| 0..1 | boolean | If cross-system closure is supported | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| D | DomainResource | Description of intented testing + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this test plan, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Business identifier identifier for the test plan | |
| Σ | 0..1 | string | Business version of the test plan | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 0..1 | string | Name for this test plan (computer friendly) | |
| T | 0..1 | string | Name for this test plan (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the test plan | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction where the test plan applies (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this test plan is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..* | CodeableConcept | The category of the Test Plan - can be acceptance, unit, performance Binding: Test Script Scope Phase Type (Example) | ||
| 0..* | Reference() | What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference | ||
| 0..1 | markdown | A description of test tools to be used in the test plan - narrative for now | ||
| 0..* | BackboneElement | The required criteria to execute the test plan - e.g. preconditions, previous tests | ||
| 0..1 | markdown | Description of the dependency criterium | ||
| 0..1 | Reference() | Link to predecessor test plans | ||
| 0..1 | markdown | The threshold or criteria for the test plan to be considered successfully executed - narrative | ||
| 0..* | BackboneElement | The test cases that constitute this plan | ||
| 0..1 | integer | Sequence of test case in the test plan | ||
| 0..* | Reference() | The scope or artifact covered by the case | ||
| 0..* | BackboneElement | Required criteria to execute the test case | ||
| 0..1 | markdown | Description of the criteria | ||
| 0..1 | Reference() | Link to predecessor test plans | ||
| 0..* | BackboneElement | The actual test to be executed | ||
| 0..1 | markdown | The narrative description of the tests | ||
| 0..1 | BackboneElement | The test cases in a structured language e.g. gherkin, Postman, or FHIR TestScript | ||
| 0..1 | CodeableConcept | The language for the test cases e.g. 'gherkin', 'testscript' | ||
| 0..1 | The actual content of the cases - references to TestScripts or externally defined content | |||
| string | ||||
| Reference() | ||||
| 0..* | BackboneElement | The test data used in the test case | ||
| 1..1 | Coding | The type of test data description, e.g. 'synthea' | ||
| 0..1 | Reference() | The actual test resources when they exist | ||
| 0..1 | Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc | |||
| string | ||||
| Reference() | ||||
| 0..* | BackboneElement | Test assertions or expectations | ||
| 0..* | CodeableConcept | Assertion type - for example 'informative' or 'required' | ||
| 0..* | CodeableReference() | The focus or object of the assertion | ||
| 0..* | CodeableReference() | The actual result assertion | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Describes the results of a TestScript execution Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | Identifier | External identifier | |
| Σ | 0..1 | string | Informal name of the executed TestReport | |
| ?!Σ | 1..1 | code | completed | in-progress | waiting | stopped | entered-in-error Binding: Test Report Status (Required) | |
| Σ | 1..1 | canonical(TestScript) | Canonical URL to the version-specific TestScript that was executed to produce this TestReport | |
| Σ | 1..1 | code | pass | fail | pending Binding: Test Report Result (Required) | |
| Σ | 0..1 | decimal | The final score (percentage of tests passed) resulting from the execution of the TestScript | |
| Σ | 0..1 | string | Name of the tester producing this report (Organization or individual) | |
| Σ | 0..1 | dateTime | When the TestScript was executed and this TestReport was generated | |
| 0..* | BackboneElement | A participant in the test execution, either the execution engine, a client, or a server | ||
| 1..1 | code | test-engine | client | server Binding: Test Report Participant Type (Required) | ||
| 1..1 | uri | The uri of the participant. An absolute URL is preferred | ||
| 0..1 | string | The display name of the participant | ||
| 0..1 | BackboneElement | The results of the series of required setup operations before the tests were executed | ||
| C | 1..* | BackboneElement | A setup operation or assert that was executed + Rule: Setup action SHALL contain either an operation or assert but not both. | |
| C | 0..1 | BackboneElement | The operation to perform | |
| 1..1 | code | pass | skip | fail | warning | error Binding: Test Report Action Result (Required) | ||
| 0..1 | markdown | A message associated with the result | ||
| 0..1 | uri | A link to further details on the result | ||
| C | 0..1 | BackboneElement | The assertion to perform | |
| 1..1 | code | pass | skip | fail | warning | error Binding: Test Report Action Result (Required) | ||
| 0..1 | markdown | A message associated with the result | ||
| 0..1 | string | A link to further details on the result | ||
| 0..* | BackboneElement | Links or references to the testing requirements | ||
| 0..1 | Link or reference to the testing requirement | |||
| uri | ||||
| canonical(Requirements) | ||||
| 0..* | BackboneElement | A test executed from the test script | ||
| 0..1 | string | Tracking/logging name of this test | ||
| 0..1 | string | Tracking/reporting short description of the test | ||
| C | 1..* | BackboneElement | A test operation or assert that was performed + Rule: Test action SHALL contain either an operation or assert but not both. | |
| 0..1 | see operation | The operation performed | ||
| 0..1 | see assert | The assertion performed | ||
| 0..1 | BackboneElement | The results of running the series of required clean up steps | ||
| 1..* | BackboneElement | One or more teardown operations performed | ||
| 1..1 | see operation | The teardown operation performed | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Describes a set of tests + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | ||
| ΣC | 0..1 | uri | Canonical identifier for this test script, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |
| Σ | 0..* | Identifier | Additional identifier for the test script | |
| Σ | 0..1 | string | Business version of the test script | |
| Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||
| string | ||||
| Coding | ||||
| ΣC | 1..1 | string | Name for this test script (computer friendly) | |
| ΣT | 0..1 | string | Name for this test script (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| T | 0..1 | markdown | Natural language description of the test script | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for test script (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |
| T | 0..1 | markdown | Why this test script is defined | |
| T | 0..1 | markdown | Use and/or publishing restrictions | |
| T | 0..1 | string | Copyright holder and year(s) | |
| 0..* | BackboneElement | An abstract server representing a client or sender in a message exchange | ||
| 1..1 | integer | The index of the abstract origin server starting at 1 | ||
| 1..1 | Coding | FHIR-Client | FHIR-SDC-FormFiller Binding: Test Script Profile Origin Type (Extensible) | ||
| 0..1 | url | The url path of the origin server | ||
| 0..* | BackboneElement | An abstract server representing a destination or receiver in a message exchange | ||
| 1..1 | integer | The index of the abstract destination server starting at 1 | ||
| 1..1 | Coding | FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor Binding: Test Script Profile Destination Type (Extensible) | ||
| 0..1 | url | The url path of the destination server | ||
| C | 0..1 | BackboneElement | Required capability that is assumed to function correctly on the FHIR server being tested + Rule: TestScript metadata capability SHALL contain required or validated or both. | |
| 0..* | BackboneElement | Links to the FHIR specification | ||
| 1..1 | uri | URL to the specification | ||
| 0..1 | string | Short description | ||
| C | 1..* | BackboneElement | Capabilities that are assumed to function correctly on the FHIR server being tested | |
| C | 1..1 | boolean | Are the capabilities required? | |
| C | 1..1 | boolean | Are the capabilities validated? | |
| 0..1 | string | The expected capabilities of the server | ||
| 0..* | integer | Which origin server these requirements apply to | ||
| 0..1 | integer | Which server these requirements apply to | ||
| 0..* | uri | Links to the FHIR specification | ||
| 1..1 | canonical(CapabilityStatement) | Required Capability Statement | ||
| 0..* | BackboneElement | Indication of the artifact(s) that are tested by this test case | ||
| 1..1 | canonical(Any) | The specific conformance artifact being tested | ||
| 0..1 | CodeableConcept | required | optional | strict Binding: Test Script Scope Conformance Type (Extensible) | ||
| 0..1 | CodeableConcept | unit | integration | production Binding: Test Script Scope Phase Type (Extensible) | ||
| 0..* | BackboneElement | Fixture in the test script - by reference (uri) | ||
| 1..1 | boolean | Whether or not to implicitly create the fixture during setup | ||
| 1..1 | boolean | Whether or not to implicitly delete the fixture during teardown | ||
| 0..1 | Reference(Any) | Reference of the resource | ||
| 0..* | canonical(StructureDefinition) | Reference of the validation profile | ||
| C | 0..* | BackboneElement | Placeholder for evaluated elements + Rule: Variable can only contain one of expression, headerField or path. | |
| 1..1 | string | Descriptive name for this variable | ||
| 0..1 | string | Default, hard-coded, or user-defined value for this variable | ||
| 0..1 | string | Natural language description of the variable | ||
| C | 0..1 | string | The FHIRPath expression against the fixture body | |
| C | 0..1 | string | HTTP header field name for source | |
| 0..1 | string | Hint help text for default value to enter | ||
| C | 0..1 | string | XPath or JSONPath against the fixture body | |
| 0..1 | id | Fixture Id of source expression or headerField within this variable | ||
| 0..1 | BackboneElement | A series of required setup operations before tests are executed | ||
| C | 1..* | BackboneElement | A setup operation or assert to perform + Rule: Setup action SHALL contain either an operation or assert but not both. | |
| C | 0..1 | BackboneElement | The setup operation to perform + Rule: Setup operation SHALL contain either sourceId or targetId or params or url. | |
| C | 0..1 | Coding | The operation code type that will be executed Binding: Test Script Operation Code (Extensible) | |
| 0..1 | uri | Resource type Binding: Concrete FHIR Types (Extensible) | ||
| 0..1 | string | Tracking/logging operation label | ||
| 0..1 | string | Tracking/reporting operation description | ||
| 0..1 | code | Mime type to accept in the payload of the response, with charset etc Binding: Mime Types (Required) | ||
| 0..1 | code | Mime type of the request payload contents, with charset etc Binding: Mime Types (Required) | ||
| 0..1 | integer | Server responding to the request | ||
| 1..1 | boolean | Whether or not to send the request url in encoded format | ||
| 0..1 | code | delete | get | options | patch | post | put | head Binding: Test Script Request Method Code (Required) | ||
| 0..1 | integer | Server initiating the request | ||
| C | 0..1 | string | Explicitly defined path parameters | |
| 0..* | BackboneElement | Each operation can have one or more header elements | ||
| 1..1 | string | HTTP header field name | ||
| 1..1 | string | HTTP headerfield value | ||
| 0..1 | id | Fixture Id of mapped request | ||
| 0..1 | id | Fixture Id of mapped response | ||
| C | 0..1 | id | Fixture Id of body for PUT and POST requests | |
| C | 0..1 | id | Id of fixture used for extracting the [id], [type], and [vid] for GET requests | |
| C | 0..1 | string | Request URL | |
| C | 0..1 | BackboneElement | The assertion to perform + Rule: Only a single assertion SHALL be present within setup action assert element. + Rule: Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. + Rule: Setup action assert response and responseCode SHALL be empty when direction equals request | |
| 0..1 | string | Tracking/logging assertion label | ||
| 0..1 | string | Tracking/reporting assertion description | ||
| C | 0..1 | code | response | request Binding: Assertion Direction Type (Required) | |
| C | 0..1 | string | Id of the source fixture to be evaluated | |
| C | 0..1 | string | The FHIRPath expression to evaluate against the source fixture | |
| C | 0..1 | string | XPath or JSONPath expression to evaluate against the source fixture | |
| C | 0..1 | code | Mime type to compare against the 'Content-Type' header Binding: Mime Types (Required) | |
| 0..1 | code | fail | pass | skip | stop Binding: Assertion Manual Completion Type (Required) | ||
| C | 0..1 | string | The FHIRPath expression to be evaluated | |
| C | 0..1 | string | HTTP header field name | |
| C | 0..1 | string | Fixture Id of minimum content resource | |
| C | 0..1 | boolean | Perform validation on navigation links? | |
| 0..1 | code | equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval Binding: Assertion Operator Type (Required) | ||
| C | 0..1 | string | XPath or JSONPath expression | |
| C | 0..1 | code | delete | get | options | patch | post | put | head Binding: Test Script Request Method Code (Required) | |
| 0..1 | string | Request URL comparison value | ||
| C | 0..1 | uri | Resource type Binding: Concrete FHIR Types (Extensible) | |
| C | 0..1 | code | continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported Binding: Assertion Response Types (Required) | |
| C | 0..1 | string | HTTP response code to test | |
| 0..1 | id | Fixture Id of source expression or headerField | ||
| 1..1 | boolean | If this assert fails, will the current test execution stop? | ||
| C | 0..1 | id | Profile Id of validation profile reference | |
| 0..1 | string | The value to compare to | ||
| 1..1 | boolean | Will this assert produce a warning only on error? | ||
| 0..* | BackboneElement | Links or references to the testing requirements | ||
| 0..1 | Link or reference to the testing requirement | |||
| uri | ||||
| canonical(Requirements) | ||||
| 0..* | BackboneElement | A test in this script | ||
| 0..1 | string | Tracking/logging name of this test | ||
| 0..1 | string | Tracking/reporting short description of the test | ||
| C | 1..* | BackboneElement | A test operation or assert to perform + Rule: Test action SHALL contain either an operation or assert but not both. | |
| C | 0..1 | see operation | The setup operation to perform + Rule: Test operation SHALL contain either sourceId or targetId or params or url. | |
| C | 0..1 | see assert | The setup assertion to perform + Rule: Only a single assertion SHALL be present within test action assert element. + Rule: Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither. + Rule: Test action assert response and response and responseCode SHALL be empty when direction equals request | |
| 0..1 | BackboneElement | A series of required clean up steps | ||
| 1..* | BackboneElement | One or more teardown operations to perform | ||
| C | 1..1 | see operation | The teardown operation to perform + Rule: Teardown operation SHALL contain either sourceId or targetId or params or url. | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Delivery of item Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | External identifier | ||
| Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of transport | |
| Σ | 0..1 | uri | Formal definition of transport | |
| Σ | 0..* | Reference(Any) | Request fulfilled by this transport | |
| Σ | 0..1 | Identifier | Requisition or grouper id | |
| Σ | 0..* | Reference(Transport) | Part of referenced event | |
| ?!Σ | 0..1 | code | in-progress | completed | abandoned | cancelled | planned | entered-in-error Binding: Transport Status (Required) | |
| Σ | 0..1 | CodeableConcept | Reason for current status Binding: Transport Status Reason (Example) | |
| Σ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: Transport Intent (Required) | |
| 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (Required) | ||
| Σ | 0..1 | CodeableConcept | Transport Type Binding: Transport Codes (Example) | |
| Σ | 0..1 | string | Human-readable explanation of transport | |
| Σ | 0..1 | Reference(Any) | What transport is acting on | |
| Σ | 0..1 | Reference(Any) | Beneficiary of the Transport | |
| Σ | 0..1 | Reference(Encounter) | Healthcare event during which this transport originated | |
| Σ | 0..1 | dateTime | Completion time of the event (the occurrence) | |
| 0..1 | dateTime | Transport Creation Date | ||
| Σ | 0..1 | dateTime | Transport Last Modified Date | |
| Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for transport to be done | |
| 0..* | CodeableConcept | Requested performer Binding: Procedure Performer Role Codes (Preferred) | ||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual | |
| Σ | 0..1 | Reference(Location) | Where transport occurs | |
| 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||
| 0..* | Annotation | Comments made about the transport | ||
| 0..* | Reference(Provenance) | Key events in history of the Transport | ||
| 0..1 | BackboneElement | Constraints on fulfillment transports | ||
| 0..1 | positiveInt | How many times to repeat | ||
| 0..1 | Period | When fulfillment sought | ||
| 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | ||
| 0..* | BackboneElement | Information used to perform transport | ||
| 1..1 | CodeableConcept | Label for the input Binding: TransportInputParameterType (Example) | ||
| 1..1 | * | Content to use in performing the transport | ||
| 0..* | BackboneElement | Information produced as part of transport | ||
| 1..1 | CodeableConcept | Label for output Binding: TransportOutputParameterType (Example) | ||
| 1..1 | * | Result of output | ||
| Σ | 1..1 | Reference(Location) | The desired location | |
| Σ | 1..1 | Reference(Location) | The entity current location | |
| 0..1 | CodeableReference(Any) | Why transport is needed Binding: TransportReason (Example) | ||
| 0..1 | Reference(Transport) | Parent (or preceding) transport | ||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| N | DomainResource | A set of codes drawn from one or more code systems + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||||||
| ΣC | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |||||
| Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | |||||
| Σ | 0..1 | string | Business version of the value set | |||||
| ΣTU | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| ΣC | 0..1 | string | Name for this value set (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this value set (human friendly) | |||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
| Σ | 0..1 | dateTime | Date last changed | |||||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| T | 0..1 | markdown | Natural language description of the value set | |||||
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | |||||
| T | 0..1 | markdown | Why this value set is defined | |||||
| T | 0..1 | markdown | Use and/or publishing restrictions | |||||
| TTU | 0..1 | string | Copyright holder and year(s) | |||||
| TU | 0..1 | date | When the ValueSet was approved by publisher | |||||
| TU | 0..1 | date | When the ValueSet was last reviewed by the publisher | |||||
| ΣTU | 0..1 | Period | When the ValueSet is expected to be used | |||||
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |||||
| TU | 0..* | ContactDetail | Who authored the ValueSet | |||||
| TU | 0..* | ContactDetail | Who edited the ValueSet | |||||
| TU | 0..* | ContactDetail | Who reviewed the ValueSet | |||||
| TU | 0..* | ContactDetail | Who endorsed the ValueSet | |||||
| TU | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| 0..1 | BackboneElement | Content logical definition of the value set (CLD) | ||||||
| Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | |||||
| Σ | 0..1 | boolean | Whether inactive codes are in the value set | |||||
| ΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) + Rule: A value set include/exclude SHALL have a value set or a system + Rule: A value set with concepts or filters SHALL include a system + Rule: Cannot have both concept and filter | |||||
| ΣC | 0..1 | uri | The system the codes come from | |||||
| Σ | 0..1 | string | Specific version of the code system referred to | |||||
| C | 0..* | BackboneElement | A concept defined in the system | |||||
| 1..1 | code | Code or expression from system | ||||||
| 0..1 | string | Text to display for this code for this value set in this valueset | ||||||
| C | 0..* | BackboneElement | Additional representations for this concept + Rule: Must have a value for concept.designation.use if concept.designation.additionalUse is present | |||||
| 0..1 | code | Human language of the designation Binding: All Languages (Required)
| ||||||
| C | 0..1 | Coding | Types of uses of designations Binding: Designation Use (Extensible) | |||||
| CTU | 0..* | Coding | Additional ways how this designation would be used Binding: Designation Use (Extensible) | |||||
| 1..1 | string | The text value for this designation | ||||||
| ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | |||||
| Σ | 1..1 | code | A property/filter defined by the code system | |||||
| Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: Filter Operator (Required) | |||||
| Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | |||||
| ΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | |||||
| TU | 0..1 | string | A copyright statement for the specific code system included in the value set | |||||
| 0..* | see include | Explicitly exclude codes from a code system or other value sets | ||||||
| TU | 0..* | string | Property to return if client doesn't override | |||||
| 0..1 | BackboneElement | Used when the value set is "expanded" | ||||||
| 0..1 | uri | Identifies the value set expansion (business identifier) | ||||||
| TU | 0..1 | uri | Opaque urls for paging through expansion results | |||||
| 1..1 | dateTime | Time ValueSet expansion happened | ||||||
| 0..1 | integer | Total number of codes in the expansion | ||||||
| 0..1 | integer | Offset at which this resource starts | ||||||
| 0..* | BackboneElement | Parameter that controlled the expansion process | ||||||
| 1..1 | string | Name as assigned by the client or server | ||||||
| 0..1 | Value of the named parameter | |||||||
| string | ||||||||
| boolean | ||||||||
| integer | ||||||||
| decimal | ||||||||
| uri | ||||||||
| code | ||||||||
| dateTime | ||||||||
| TU | 0..* | BackboneElement | Additional information supplied about each concept | |||||
| 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||||
| 0..1 | uri | Formal identifier for the property | ||||||
| C | 0..* | BackboneElement | Codes in the value set + Rule: SHALL have a code or a display + Rule: SHALL have a code if not abstract + Rule: SHALL have a system if a code is present | |||||
| C | 0..1 | uri | System value for the code | |||||
| C | 0..1 | boolean | If user cannot select this entry | |||||
| 0..1 | boolean | If concept is inactive in the code system | ||||||
| 0..1 | string | Version in which this code/display is defined | ||||||
| C | 0..1 | code | Code - if blank, this is not a selectable code | |||||
| C | 0..1 | string | User display for the concept | |||||
| 0..* | see designation | Additional representations for this item | ||||||
| TU | 0..* | BackboneElement | Property value for the concept | |||||
| 1..1 | code | Reference to ValueSet.expansion.property.code | ||||||
| 1..1 | Value of the property for this concept | |||||||
| code | ||||||||
| Coding | ||||||||
| string | ||||||||
| integer | ||||||||
| boolean | ||||||||
| dateTime | ||||||||
| decimal | ||||||||
| 0..* | BackboneElement | SubProperty value for the concept | ||||||
| 1..1 | code | Reference to ValueSet.expansion.property.code | ||||||
| 1..1 | Value of the subproperty for this concept | |||||||
| code | ||||||||
| Coding | ||||||||
| string | ||||||||
| integer | ||||||||
| boolean | ||||||||
| dateTime | ||||||||
| decimal | ||||||||
| 0..* | see contains | Codes contained under this entry | ||||||
| TU | 0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description | |||||
| 0..1 | string | Criteria describing which concepts or codes should be included and why | ||||||
| 0..1 | string | Criteria describing which concepts or codes should be excluded and why | ||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Describes validation requirements, source(s), status and dates for one or more elements Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Reference(Any) | A resource that was validated | |
| Σ | 0..* | string | The fhirpath location(s) within the resource that was validated | |
| Σ | 0..1 | CodeableConcept | none | initial | periodic Binding: need (Preferred) | |
| Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error Binding: Verification Result status (Required) | |
| Σ | 0..1 | dateTime | When the validation status was updated | |
| Σ | 0..1 | CodeableConcept | nothing | primary | multiple Binding: validation-type (Preferred) | |
| Σ | 0..* | CodeableConcept | The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) Binding: validation-process (Example) | |
| 0..1 | Timing | Frequency of revalidation | ||
| 0..1 | dateTime | The date/time validation was last completed (including failed validations) | ||
| 0..1 | date | The date when target is next validated, if appropriate | ||
| Σ | 0..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (Preferred) | |
| 0..* | BackboneElement | Information about the primary source(s) involved in validation | ||
| 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source | ||
| Σ | 0..* | CodeableConcept | Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) Binding: primary-source-type (Example) | |
| Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (Example) | |
| 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (Preferred) | ||
| 0..1 | dateTime | When the target was validated against the primary source | ||
| Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (Preferred) | |
| 0..* | CodeableConcept | specific | any | source Binding: push-type-available (Preferred) | ||
| 0..1 | BackboneElement | Information about the entity attesting to information | ||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information | |
| Σ | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | |
| Σ | 0..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (Example) | |
| Σ | 0..1 | date | The date the information was attested to | |
| 0..1 | string | A digital identity certificate associated with the attestation source | ||
| 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | ||
| 0..1 | Signature | Proxy signature (digital or image) | ||
| 0..1 | Signature | Attester signature (digital or image) | ||
| 0..* | BackboneElement | Information about the entity validating information | ||
| 1..1 | Reference(Organization) | Reference to the organization validating information | ||
| 0..1 | string | A digital identity certificate associated with the validator | ||
| 0..1 | Signature | Validator signature (digital or image) | ||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Prescription for vision correction products for a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business Identifier for vision prescription | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (Required) | |
| Σ | 1..1 | dateTime | Response creation date | |
| Σ | 1..1 | Reference(Patient) | Who prescription is for | |
| 0..1 | Reference(Encounter) | Created during encounter / admission / stay | ||
| Σ | 1..1 | dateTime | When prescription was authorized | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole) | Who authorized the vision prescription | |
| Σ | 1..* | BackboneElement | Vision lens authorization | |
| Σ | 1..1 | CodeableConcept | Product to be supplied Binding: Example Vision Prescription Product Codes (Example) | |
| Σ | 1..1 | code | right | left Binding: Vision Eyes (Required) | |
| 0..1 | decimal | Power of the lens | ||
| 0..1 | decimal | Lens power for astigmatism | ||
| 0..1 | integer | Lens meridian which contain no power for astigmatism | ||
| 0..* | BackboneElement | Eye alignment compensation | ||
| 1..1 | decimal | Amount of adjustment | ||
| 1..1 | code | up | down | in | out Binding: Vision Base (Required) | ||
| 0..1 | decimal | Added power for multifocal levels | ||
| 0..1 | decimal | Contact lens power | ||
| 0..1 | decimal | Contact lens back curvature | ||
| 0..1 | decimal | Contact lens diameter | ||
| 0..1 | SimpleQuantity | Lens wear duration | ||
| 0..1 | string | Color required | ||
| 0..1 | string | Brand required | ||
| 0..* | Annotation | Notes for coatings | ||